AFNotificationRuleTemplate.GetAllDeliveryFormats Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets a read only collection of all AFDeliveryFormat that belong to this
AFNotificationRuleTemplate and to the PISystem.
Namespace: OSIsoft.AF.Notification
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFNamedCollectionList<AFDeliveryFormat> GetAllDeliveryFormats( AFPlugIn deliveryChannelPlugIn = null )
Public Function GetAllDeliveryFormats ( Optional deliveryChannelPlugIn As AFPlugIn = Nothing ) As AFNamedCollectionList(Of AFDeliveryFormat) Dim instance As AFNotificationRuleTemplate Dim deliveryChannelPlugIn As AFPlugIn Dim returnValue As AFNamedCollectionList(Of AFDeliveryFormat) returnValue = instance.GetAllDeliveryFormats(deliveryChannelPlugIn)
public: AFNamedCollectionList<AFDeliveryFormat^>^ GetAllDeliveryFormats( AFPlugIn^ deliveryChannelPlugIn = nullptr )
member GetAllDeliveryFormats : ?deliveryChannelPlugIn : AFPlugIn (* Defaults: let _deliveryChannelPlugIn = defaultArg deliveryChannelPlugIn null *) -> AFNamedCollectionList<AFDeliveryFormat>
Parameters
- deliveryChannelPlugIn (Optional)
- Type: OSIsoft.AFAFPlugIn
Optionally filter results to only the specified delivery channel plug in.
Return Value
Type: AFNamedCollectionListAFDeliveryFormatA collection of all AFDeliveryFormat that belong to this AFNotificationRuleTemplate and to the PISystem.
Remarks
This method gets a collection of all AFDeliveryFormat objects that belong to this AFNotificationRuleTemplate and the PISystem. It will not include any AFDeliveryFormat objects that belong to any AFNotificationRule that was created from this template.
The output from this method may be used to create a unique name using the GenerateUniqueName(String, IAFList) method.