IAdsHandle.DeleteVariableHandleAsync Method

Releases the specified symbol/variable handle asynchronously.

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

Task<ResultAds> DeleteVariableHandleAsync(
    uint variableHandle,
    CancellationToken cancel
)

Parameters

variableHandle

Type: System.UInt32
Handle of the ADS variable

cancel

Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task.ResultAds.
A task that represents the asynchronous 'DeleteVariableHandle' operation. The ResultAds parameter contains the ErrorCode after execution.

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 DeleteVariableHandleAsync(UInt32, CancellationToken) is the CreateVariableHandleAsync(String, CancellationToken)

Reference

IAdsHandle Interface

TwinCAT.Ads Namespace

IAdsHandle.CreateVariableHandleAsync(String, CancellationToken)

IAdsHandle.TryDeleteVariableHandle(UInt32)

IAdsHandle.DeleteVariableHandle(UInt32)