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

AF SDK Reference

AFTransfer.IsValidDestination Method (AFElement, AFPort, String)

AFTransfer.IsValidDestination Method (AFElement, AFPort, String)

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

Note: This API is now obsolete.

This method checks if the specified port is valid as the destination 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.IsValidDestination(AFPort destinationPort, out string errMsg).  There is no need to specify both a element and its port.")]
public bool IsValidDestination(
	AFElement destinationElement,
	AFPort destinationPort,
	out string errMsg
)
<BrowsableAttribute(false)>
<ObsoleteAttribute("Use AFTransfer.IsValidDestination(AFPort destinationPort, out string errMsg).  There is no need to specify both a element and its port.")>
Public Function IsValidDestination ( 
	destinationElement As AFElement,
	destinationPort As AFPort,
	<OutAttribute> ByRef errMsg As String
) As Boolean

Dim instance As AFTransfer
Dim destinationElement As AFElement
Dim destinationPort As AFPort
Dim errMsg As String
Dim returnValue As Boolean

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

Parameters

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

Return Value

Type: Boolean
Returns if the specified is valid as a destination 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 IsValidDestination(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