IObjectDictionary.ReadObject (METH)ΒΆ

METHOD ReadObject : ABORT_CODE

Used to read an object of the local object dictionary. If ABORT_CODE.SUCCESSFUL is returned pbyData contains the read data. If error occured the corresponding abort code is returned. Difference to IObjectDictionary.ReadObjectByAddress: Better performance because itfObject is an input variable => no internal binary search necessary.

InOut:

Scope

Name

Type

Initial

Comment

Return

ReadObject

ABORT_CODE

ABORT_CODE.SUCCESSFUL: Reading successful, pbyData contains data; ELSE: Reading not permitted

Input

itfObject

IODObject

Object which should be read.

bySubIndex

BYTE

Subindex of object

xCheckAccess

BOOL

TRUE

TRUE: Access rights should be checked. Reading a writeonly object will fail. FALSE: Ignore access rights and force reading.

xDataInBusOrder

BOOL

Specifies in which Byte Order data should be read; TRUE: Data should be read in CANopen Byteorder (Little Endian), FALSE: Data should be read in Host Byte Order

pbyData

POINTER TO BYTE

Pointer to data where the object value should be copied to.

Inout

udiSize

UDINT

VAR IN: Size of memory pbyData points to; VAR OUT: Size of object