AFTransfer.IsValidSource Method (AFPort, String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method checks if the specified port is valid as the source of this transfer.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool IsValidSource( AFPort sourcePort, out string errMsg )
Public Function IsValidSource ( sourcePort As AFPort, <OutAttribute> ByRef errMsg As String ) As Boolean Dim instance As AFTransfer Dim sourcePort As AFPort Dim errMsg As String Dim returnValue As Boolean returnValue = instance.IsValidSource(sourcePort, errMsg)
public: bool IsValidSource( AFPort^ sourcePort, [OutAttribute] String^% errMsg )
member IsValidSource : sourcePort : AFPort * errMsg : string byref -> bool
Parameters
- sourcePort
- Type: OSIsoft.AF.ModelingAFPort
The source AFPort object of the transfer. The port type must be Output. - errMsg
- Type: SystemString
The returned error message if the specified port is invalid as the source of this transfer.
Return Value
Type: BooleanReturns if the specified is valid as a source for this transfer. If it is invalid, returns and the errMsg parameter specifies the error message.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | This exception is thrown when the sourcePort parameter is . |