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

AF SDK Reference

AFVariableMap.TryGetMapping Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFVariableMap.TryGetMapping Method
Tries to find an AFVariableMappingData for the specified variable name.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public bool TryGetMapping(
	string variableName,
	out AFVariableMappingData variableMapping
)
Public Function TryGetMapping ( 
	variableName As String,
	<OutAttribute> ByRef variableMapping As AFVariableMappingData
) As Boolean

Dim instance As AFVariableMap
Dim variableName As String
Dim variableMapping As AFVariableMappingData
Dim returnValue As Boolean

returnValue = instance.TryGetMapping(variableName, 
	variableMapping)
public:
bool TryGetMapping(
	String^ variableName, 
	[OutAttribute] AFVariableMappingData^% variableMapping
)
member TryGetMapping : 
        variableName : string * 
        variableMapping : AFVariableMappingData byref -> bool 

Parameters

variableName
Type: SystemString
The name of the variable whose configuration should be retrieved.
variableMapping
Type: OSIsoft.AF.AnalysisAFVariableMappingData
The AFVariableMappingData, if one was found.

Return Value

Type: Boolean
True if the variable name was found.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

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