AdsClientTryCreateVariableHandle Method

Determines the Symbol handle by its instance path synchronously.


Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public AdsErrorCode TryCreateVariableHandle(
    string symbolPath,
    out uint variableHandle
)

Parameters

symbolPath  String

SymbolName / InstancePath.

variableHandle  UInt32

The symbols handle.

Return Value

AdsErrorCode
The ADS error code.

Implements

IAdsHandleTryCreateVariableHandle(String, UInt32)

Remarks

It is a good practice to release all variable handles after use to regain internal resources in the TwinCAT subsystem. The composite method to this TryCreateVariableHandle(String, UInt32) is the TryDeleteVariableHandle(UInt32)

Reference

AdsClient Class TwinCAT.Ads Namespace TryDeleteVariableHandle(UInt32) CreateVariableHandleAsync(String, CancellationToken) CreateVariableHandle(String)

Beckhoff Automation GmbH & Co. KG 2001-2026