Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFTransfer.IsValidSource Method (AFElement, AFPort, String)

AFTransfer.IsValidSource Method (AFElement, AFPort, String)

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFTransfer.IsValidSource Method (AFElement, AFPort, String)

Note: This API is now obsolete.

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

[BrowsableAttribute(false)]
[ObsoleteAttribute("Use AFTransfer.IsValidSource(AFPort sourcePort, out string errMsg).  There is no need to specify both a element and its port.")]
public bool IsValidSource(
	AFElement sourceElement,
	AFPort sourcePort,
	out string errMsg
)
<BrowsableAttribute(false)>
<ObsoleteAttribute("Use AFTransfer.IsValidSource(AFPort sourcePort, out string errMsg).  There is no need to specify both a element and its port.")>
Public Function IsValidSource ( 
	sourceElement As AFElement,
	sourcePort As AFPort,
	<OutAttribute> ByRef errMsg As String
) As Boolean

Dim instance As AFTransfer
Dim sourceElement As AFElement
Dim sourcePort As AFPort
Dim errMsg As String
Dim returnValue As Boolean

returnValue = instance.IsValidSource(sourceElement, 
	sourcePort, errMsg)
public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"Use AFTransfer.IsValidSource(AFPort sourcePort, out string errMsg).  There is no need to specify both a element and its port.")]
bool IsValidSource(
	AFElement^ sourceElement, 
	AFPort^ sourcePort, 
	[OutAttribute] String^% errMsg
)
[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("Use AFTransfer.IsValidSource(AFPort sourcePort, out string errMsg).  There is no need to specify both a element and its port.")>]
member IsValidSource : 
        sourceElement : AFElement * 
        sourcePort : AFPort * 
        errMsg : string byref -> bool 

Parameters

sourceElement
Type: OSIsoft.AF.AssetAFElement
The source element of the transfer.
sourcePort
Type: OSIsoft.AF.ModelingAFPort
The source AFPort object of the transfer.
errMsg
Type: SystemString
The returned error message if the specified port is invalid as the source of this transfer.

Return Value

Type: Boolean
Returns if the specified is valid as a source for this transfer. If it is invalid, returns and the errMsg parameter specifies the error message.

Remarks

This method is obsolete and has been replaced by the IsValidSource(AFPort, out string) method.

Version Information

AFSDK

Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9
Obsolete (compiler warning) in 2.8.5
Obsolete (compiler warning) in 2.8
Obsolete (compiler warning) in 2.7.5
Obsolete (compiler warning) in 2.7
Obsolete (compiler warning) in 2.6
Obsolete (compiler warning) in 2.5
Obsolete (compiler warning) in 2.4

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in