TcAdsClient.ReadAnyString Method (Int32, Int32, Encoding)

Reads the string.

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

Syntax

C#

public string ReadAnyString(
    int variableHandle,
    int len,
    Encoding encoding
)

VB

Public Function ReadAnyString ( 
    variableHandle As Integer,
    len As Integer,
    encoding As Encoding
) As String

Parameters

variableHandle

Type: System.Int32
The variable handle.

len

Type: System.Int32
The length of the string (e.g. 80 for STRING[80] or WSTRING[80]

encoding

Type: System.Text.Encoding
The encoding (Default or Unicode).

Return Value

Type: String
System.String.

Implements

IAdsAnyAccess.ReadAnyString(Int32, Int32, Encoding)

Examples

The following code shows how to Read/Write string values with the ANY concept.

Read/Write Any Strings

using (TcAdsClient client = new TcAdsClient())
{
    client.Connect(851); // Connect to local port 851 (PLC)

    int stringHandle = client.CreateVariableHandle("MAIN.string"); // Symbol "string" defined in MAIN as STRING
    int wStringHandle = client.CreateVariableHandle("MAIN.wstring"); // Symbol "string" defined in MAIN as WSTRING

    try
    {
    string str = client.ReadAnyString(stringHandle, 80, Encoding.Default);
    string wStr = client.ReadAnyString(wStringHandle, 80, Encoding.Unicode);

    string changedValue = "Changed";

    // Attention, take care that the memory of the string in the process image is not exceeded!
    client.WriteAnyString(stringHandle, changedValue, 80, Encoding.Default);
    client.WriteAnyString(wStringHandle, changedValue, 80, Encoding.Unicode);
    }
    finally
    {
    client.DeleteVariableHandle(stringHandle);
    client.DeleteVariableHandle(wStringHandle);
    }
}

Reference

TcAdsClient Class

ReadAnyString Overload

TwinCAT.Ads Namespace