FB_RegQueryValue

 VAR_INPUT

VAR_INPUT
    sNetId      :T_AmsNetId;   
    sSubKey     :T_MaxString; 
    sValName    :T_MaxString;
    cbData      :UDINT;
    pData       :UDINT; 
    bExecute    :BOOL;
    tTimeOut    :TIME := DEFAULT_ADS_TIMEOUT;
END_VAR

sNetId: Here a string containing the network address of the TwinCAT Computer can be given, whose system registration should be read. The string can also be empty for the local computer.    

sSubKey: String with SubKey  name.

sValName: String with value name.

cbData: Number of value data bytes to be read.

pData:  Address of a data buffer/variables to which the value data should be copied.  The address can be ascertained from the ADR-Operator. The programmer himself is responsible for the dimension of the data buffer:.it must be possible to take cbData data bytes into the buffer.

bExecute: The command is executed with a positive edge at the input

tTimeOut: Maximum time allowed for the execution of the ADS command.

VAR_OUTPUT

VAR_OUTPUT
    bBusy       :BOOL;
    bError      :BOOL;
    nErrId      :UDINT;
    cbRead      :UDINT;
END_VAR

bBusy: When the function block is activated this output is set. It remains set until and acknowledgement is received.

bError:  If an ADS error should occur during the execution of the command, then this output is set, after the bBusy output has been reset. 

nErrId: When the bError output is set, this variable supplies the ADS error or the command-specific error code (table).

cbRead: Number of successfully read value data bytes.

Examples:

The values AxisID and LogFilePath should be read from the system Registry. 

PROGRAM MAIN
VAR
    fbRegQueryValue : FB_RegQueryValue;
    bRead           : BOOL;
    bBusy           : BOOL;
    bError          : BOOL;
    nErrId          : UDINT;
    cbRead          : UDINT;
    sValData        : STRING;
    nAxisID         : DWORD;
END_VAR

Read REG_DWORD-Value:

The value 0x22 of the registry was read in the PLC variable nAxisId .

Read REG_SZ-Value :

The string 'c:\MyProject\Log' of the registry  was read in the PLC variable sValData.

Requirements