RtecatOpenSubDeviceByExplicitId

RtecatOpenSubDeviceByExplicitId opens a SubDevice by its explicit identification.

Syntax

Copy

RTECAT_ERROR RtecatOpenSubDeviceByExplicitId(
  [in]    RTECAT_HANDLE MainDevice,
  [out]   RTECAT_HANDLE* pSubDevice,
  [in]    WORD ExplicitId  
);

Parameters

[in] MainDevice

A handle to a MainDevice. To retrieve the corresponding handle, use RtecatCreateMainDevice or RtecatOpenMainDevice.

[out] pSubDevice

A pointer to a SubDevice handle.

[in] ExplicitId

The explicit identification of a SubDevice.

Return Values

The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter pSubDevice is NULL.
ecatErrWrongParameter	Parameter MainDevice or ExplicitId is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatOpenSubDeviceByExplicitId is a synchronous function that executes immediately and returns a result upon completion.

Requirements

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