Command Details: Get_Record
Category
Extended
Details
Command Code: | 10h |
Valid for: | Object Instance |
Description
The module issues this command in the following situations:
Module receives a Record Data Read request towards an API other than 0 (zero).
Module receives a Record Data Read request towards API 0, but the record in question is handled in Transparent Mode.
See instance attribute #7 for more information about Transparent Mode.
See Flowchart — Record Data Access for more information.
It is optional to implement support for this command. If not implemented, the original network request will be rejected and an error is returned to the IO Controller/Supervisor.
Command Details
Field
Contents
Comments
CmdExt[0]
AR handle (low byte)
Handle for Application Relationship (AR)
CmdExt[1]
AR handle (high byte)
MsgData[0]
API (low word, low byte)
Application Process Instance (API)
MsgData[1]
API (low word, high byte)
MsgData[2]
API (high word, low byte)
MsgData[3]
API (high word, high byte)
MsgData[4]
Slot (low byte)
Slot number of request
MsgData[5]
Slot (high byte)
MsgData[6]
Subslot (low byte)
Subslot number of request
MsgData[7]
Subslot (high byte)
MsgData[8]
Index (low byte)
Index of request
MsgData[9]
Index (high byte)
MsgData[10]
Length (low byte)
Range: 1 - 1524
MsgData[11] is only available if the length value exceeds 255.
MsgData[11]
Length (high byte)
Response Details (Success)
Field
Contents
Comments
CmdExt[0... 1]
(reserved)
(set to zero)
MsgData[0... n]
Data (up to 1524 bytes)
Data to be returned in the Record Data Read response.
Response Details (Error)
Field
Contents
Comments
CmdExt[0... 1]
(reserved)
(set to zero)
MsgData[0]
FFh
Object specific error
MsgData[1]
Error Code 1
MsgData[2]
Error Code 2
User specific error code
MsgData[3]
Additional Data 1
API specific. Set to zero if no Additional Data 1 is defined.
MsgData[4]
Additional Data 2
User specific. Set to zero if no Additional Data 2 is defined.
See also...
Details for the command Set_Record (below)