✕
✕

SystemDataItemKeyByIndex

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

ns=2;s=DEPRAG Smart/Devices/DEPRAG/AST/ActiveDevices/0/SystemOverview/SystemData/SystemDataItemKeyByIndex

Requests an index-dependent key from the system data.

Parameters:

    Index
    Index of the key that is requested.

Returns:

    SystemDataItemKeyByIndex
    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:

    bAstSystemDataKeyByIndex
    A boolean variable that can be used to trigger the execution of the SystemDataItemKeyByIndex command.
    outputAstSystemDataKeyByIndex
    An instance of the ST_StringOutputData structure into which the return value of the SystemDataItemKeyByIndex method is written.
    hrAstSystemDataKeyByIndex
    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 system data is to be fetched.
    nIndex
    An int variable that represents the index of the key being requested.
    ConnectionHandle
    "ConnectionHandle" received when establishing a connection between DEPRAG Smart Server and your OPC UA client. 


VAR
     bAstSystemDataKeyByIndex    : BOOL;
     outputAstSystemDataKeyByIndex   : ST_StringOutputData;                                          
     hrAstSystemDataKeyByIndex    : HRESULT;

     fbAst   : FB_AST;
END_VAR

hrAstSystemDataKeyByIndex := fbAst.SystemDataItemKeyByIndex(
       bExecute    := bAstSystemDataKeyByIndex,   
       ConnectionHandle := depragSmartConnection.ConnectionHandle,
       sDeviceId   := '0',
       nIndex    := 0,
       OutputData   => outputAstSystemDataKeyByIndex);
IF hrAstSystemDataKeyByIndex <> S_FALSE THEN 
    bAstSystemDataKeyByIndex := 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".