AFVariableMap.TryGetMapping Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
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: BooleanTrue if the variable name was found.