TcAdsClient.CreateVariableHandle Method

Generates a unique handle for an ADS variable.

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public int CreateVariableHandle(
    string variableName
)

VB

Public Function CreateVariableHandle ( 
    variableName As String
) As Integer

Parameters

variableName

Type: System.String
Name of the ADS variable

Return Value

Type: Int32
The handle of the ADS Variable.

Implements

IAdsHandleAccess.CreateVariableHandle(String)

Exceptions

Exception

Condition

AdsErrorException

Thrown when the ADS call fails.

Reference

TcAdsClient Class

TwinCAT.Ads Namespace