RtecatReadSubDeviceAlias

RtecatReadSubDeviceAlias reads the alias address from a SubDevice.

Syntax

Copy

RTECAT_COMMAND_STATUS RtecatReadSubDeviceAlias(
  [in]    RTECAT_HANDLE SubDevice,
  [out]   WORD* pAlias
);

Parameters

[in] SubDevice

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

[out] pAlias

A pointer to a variable that stores the alias address from a SubDevice.

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 pAlias is NULL.
ecatErrWrongParameter	Parameter SubDevice is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.

Remarks

RtecatReadSubDeviceAlias 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)