AFPlugIn.CreateDeliveryChannelInstance Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Create an AFDeliveryChannel instance of a plugin.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFDeliveryChannel CreateDeliveryChannelInstance( AFObject context, string configString )
Public Function CreateDeliveryChannelInstance ( context As AFObject, configString As String ) As AFDeliveryChannel Dim instance As AFPlugIn Dim context As AFObject Dim configString As String Dim returnValue As AFDeliveryChannel returnValue = instance.CreateDeliveryChannelInstance(context, configString)
public: AFDeliveryChannel^ CreateDeliveryChannelInstance( AFObject^ context, String^ configString )
member CreateDeliveryChannelInstance : context : AFObject * configString : string -> AFDeliveryChannel
Parameters
- context
- Type: OSIsoft.AFAFObject
The context object that owns the plugin instance. If specified it must be either an AFNotificationContactTemplate, AFNotificationContact or AFNotificationRuleSubscriber. If , then the plugin instance is not associated with any object and executes without any context. - configString
- Type: SystemString
The configuration string used to initialize the plugin instance. If , then the instance will be initialized to its default values.
Return Value
Type: AFDeliveryChannelReturns the newly created plugin AFDeliveryChannel instance.
Remarks
Typically, it is not necessary to invoke this method, as plugin instances are created for you through SDK objects. However, in special cases, such as constructing a composite Analysis Rule, Time Rule, or Data Reference, it may be useful to invoke other plugins directly.
Before a plugin type can be used in function, its type must be defined or an exception will be thrown at runtime. To avoid this runtime error and make sure the plugin type is loaded, make a call to the GetPlugInType method before any function is called which uses the plugin type.