AdsConnectionTryDeleteVariableHandle Method

Releases the specified symbol/variable handle synchronously.

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

Syntax

C#

public AdsErrorCode TryDeleteVariableHandle(
    uint variableHandle
)

Parameters

variableHandle UInt32

Handle of the ADS variable

Return Value

AdsErrorCode
The ADS error code.

Implements

IAdsHandleTryDeleteVariableHandle(UInt32)

Exceptions

Exception	Condition
ObjectDisposedException
ClientNotConnectedException

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 TryDeleteVariableHandle(UInt32) is the TryCreateVariableHandle(String, UInt32)

Reference

AdsConnection Class TwinCAT.Ads Namespace TryCreateVariableHandle(String, UInt32) DeleteVariableHandleAsync(UInt32, CancellationToken) DeleteVariableHandle(UInt32)

Beckhoff Automation GmbH & Co. KG 2001-2026