RtecatReadAllSubDeviceEEprom
RtecatReadAllSubDeviceEEprom reads all data from a SubDevice's EEPROM.
Syntax
RTECAT_COMMAND_STATUS RtecatReadAllSubDeviceEEprom(
[in] RTECAT_HANDLE SubDevice,
[out] const wchar_t* pFile
);Parameters
[in] SubDevice
A handle to a SubDevice. To retrieve the corresponding handle, use RtecatOpenSubDeviceByIndex, RtecatOpenSubDeviceByStationAddress, or RtecatOpenSubDeviceByExplicitId.
[out] pFile
A pointer to a file path that stores all data from a SubDevice's EEPROM.
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. |
|
ecatErrWrongParameter |
Parameter SubDevice is invalid. |
|
ecatErrWrongEnvironment |
The EEPROM requesting channel is occupied. |
|
ecatErrMainDeviceNotReady |
The MainDevice is not ready. |
|
ecatErrWrongSubDeviceState |
The feature can't be used in the current SubDevice state. It can only be used in the Init state. |
|
ecatErrNoFile |
The file path is invalid or inaccessible. |
Remarks
RtecatReadAllSubDeviceEEprom 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) |
See Also:
