AF SDK Reference

AFDeliveryFormats.Add Method (String, AFPlugIn)

Save PDF

TABLE OF CONTENTS

AFDeliveryFormats.Add Method (String, AFPlugIn)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The Add method creates a new object and adds it to the collection.

Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFDeliveryFormat Add(
	string name,
	AFPlugIn deliveryChannelPlugIn
)

Public Function Add ( 
	name As String,
	deliveryChannelPlugIn As AFPlugIn
) As AFDeliveryFormat

Dim instance As AFDeliveryFormats
Dim name As String
Dim deliveryChannelPlugIn As AFPlugIn
Dim returnValue As AFDeliveryFormat

returnValue = instance.Add(name, deliveryChannelPlugIn)

public:
AFDeliveryFormat^ Add(
	String^ name, 
	AFPlugIn^ deliveryChannelPlugIn
)

member Add : 
        name : string * 
        deliveryChannelPlugIn : AFPlugIn -> AFDeliveryFormat

Parameters

name: Type: SystemString
The name for the new object, which must be unique within the collection. If the name ends with an asterisk (*), then a unique name will be generated based on the supplied name. See the ValidateName(String, String) method for a description of what is valid when setting the name of the object.
deliveryChannelPlugIn: Type: OSIsoft.AFAFPlugIn
Specifies the AFDeliveryChannel to be used for the new AFDeliveryFormat.

Return Value

Type: AFDeliveryFormat
Returns the newly created object that was added to the collection.

Remarks

The new object will be created with the specified name. All other properties of the object will be set to their default value.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

AF SDK Reference