Get_Attribute_All: Get All Attributes of an Object
This function block returns the content of all attributes of an object.
This table describes the input variable:
|
Input |
Data type |
Comment |
|---|---|---|
|
i_xExecute |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. A rising edge of the input Execute starts the function block. The function block continues execution and the output Busy is set to TRUE. oFALSE: If Enable is set to FALSE, the outputs Done, Error, or CommandAborted are set to TRUE for one cycle. oTRUE: If Enable is set to FALSE, the outputs Done, Error, or CommandAborted remain set to TRUE. |
|
i_xAbort |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been aborted. oTRUE: Execution has been aborted by another function block. |
|
i_xMsgType |
BOOL |
oFALSE: UCCM oTRUE: Connected (Class 3) message |
|
i_adTargetIP |
TCP_ADDR |
IP address of target. |
|
i_dwClass |
DWORD |
Target class. Refer to How To Find Object Information in Device Documentation. It must be 0xFFFFFFFF if the class is not part of the request. |
|
i_dwInstance |
DWORD |
Target instance. Refer to How To Find Object Information in Device Documentation. It can be 0 if the target is a class instance. It must be 0xFFFFFFFF if the instance is not part of the request. |
This table describes the output variable:
|
Output |
Data type |
Comment |
|---|---|---|
|
q_xDone |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been started, or an error has been detected. oTRUE: Execution terminated without an error detected. |
|
q_xBusy |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Function block is not being executed. oTRUE: Function block is being executed. |
|
q_xAborted |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been aborted. oTRUE: Execution has been aborted by Abort input. |
|
q_xError |
BOOL |
Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution of the function block is running, no error has been detected. oTRUE: An error has been detected in the execution of the function block. |
|
q_byCommError |
BYTE |
Gives information about the detected error. |
|
q_dwOperError |
DWORD |
Gives information about the detected error. |
|
q_abyResponseData |
ARRAY OF BYTE 0…MAX_EIP_REQUEST_DATA_SIZE |
Response data in case of a success.1 |
|
q_wDataSize |
WORD |
The size of the response data in bytes. |
|
1 The Get_Attribute_All function returns a formatted buffer according to the ODVA specification. Refer to CIP Get_Attribute_All response. |
||
