RtecatReadSubDeviceRegister

RtecatReadSubDeviceRegister reads data from a SubDevice's register.

Syntax

Copy

RTECAT_COMMAND_STATUS RtecatReadSubDeviceRegister(
  [in]    RTECAT_HANDLE SubDevice,
  [in]    USHORT Offset,
  [in]    USHORT Length,
  [out]   BYTE* pData
);

Parameters

[in] SubDevice

A handle to a SubDevice. To retrieve the corresponding handle, use RtecatOpenSubDeviceByIndex, RtecatOpenSubDeviceByStationAddress, or RtecatOpenSubDeviceByExplicitId.

[in] Offset

The offset within the SubDevice's register to start reading.

[in] Length

The length, in bytes, of the data to be read from the specified offset. The valid range is 1-512.

[out] pData

A pointer to the buffer that stores the data from a SubDevice's register.

Return Values

The function returns an RTECAT_COMMAND_STATUS structure. If an error occurs, field State of the structure is set to ecatCommandError and the error code is stored in field ErrorId (see RTECAT_ERROR for error values). If the function succeeds, ErrorId is set to ecatErrNoError (which is represented by the value 0). If the function fails, it stores a different error value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter pData is NULL.
ecatErrWrongParameter	One of the following conditions occurred: Parameter SubDevice is invalid. The value of parameter Length is zero (0) or greater than 512.
ecatErrMainDeviceNotReady	The MainDevice is not ready.

Remarks

RtecatReadSubDeviceRegister is an asynchronous function that takes time to complete. It allows for background execution and requires you to check its status by calling RtecatGetCommandStatus or wait for it to complete by calling RtecatWaitForCommand.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)