✕
✕

ToolDataItemKeyByIndex

TwinCAT TIA
Devices DEPRAG devices Sequence controller ActiveDevices One client System info Tool data

ns=2;s=DEPRAG Smart/Devices/DEPRAG/AST/ActiveDevices/0/SystemOverview/ToolData/ToolDataItemKeyByIndex

Requests an index-dependent key of the tool data.

Parameters:

    Index
    Index of the key that is requested.

Returns:

    ToolDataItemKeyByIndex
    A variable of type OpcMethodReturnValueString. The Result property contains the command-specific return values.
      Result
      Value of the index-dependent key.

Examples:

In addition to the parameters already explained, the following variables must be created / transferred for the implementation in TwinCAT 3:

Beckhoff parameter:

    bAstToolDataItemKeyByIndex
    A boolean variable that can be used to trigger the execution of the ToolDataItemKeyByIndex command.
    outputAstToolDataItemKeyByIndex
    An instance of the ST_StringOutputData structure into which the return value of the ToolDataItemKeyByIndex method is written.
    hrAstToolDataKeyItemByIndex
    This can be used to monitor the execution of the command. Error codes have the type HRESULT.
    fbAst
    An instance of the FB_AST function block supplied with the DEPRAG Smart library.
    sDeviceId
    A string value specifying the device for which tool data is to be fetched.
    ConnectionHandle
    "ConnectionHandle" received when establishing a connection between DEPRAG Smart Server and your OPC UA client. 


VAR
     bAstToolDataItemKeyByIndex    : BOOL;
     outputAstToolDataItemKeyByIndex   : ST_StringOutputData;                                          
     hrAstToolDataKeyItemByIndex    : HRESULT;

     fbAst   : FB_AST;
END_VAR

hrAstToolDataItemKeyByIndex := fbAst.ToolDataItemKeyByIndex(
       bExecute    := bAstToolDataItemKeyByIndex,   
       ConnectionHandle := depragSmartConnection.ConnectionHandle,
       sDeviceId   := '0',
       nIndex    := 0,
       OutputData   => outputAstToolDataItemKeyByIndex);
IF hrAstToolDataKeyByIndex <> S_FALSE THEN 
 bAstToolDataKeyByIndex := FALSE;
END_IF

For examples and explanations regarding the calls of nodes via Siemens TIA Portal please refer to the sub-menu "Siemens TIA Portal" in section "Getting Started".