RtecatOpenMainDevice

RtecatOpenMainDevice opens a MainDevice.

Syntax

Copy

RTECAT_ERROR RtecatOpenMainDevice(
  [out]   RTECAT_HANDLE* pMainDevice,
  [in]    ULONG Instance  
);

Parameters

[out] pMainDevice

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

[in] Instance

The index of a MainDevice instance.

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 pMainDevice is NULL.
ecatErrWrongParameter	Parameter Instance is < 0 or >= 63.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.

Remarks

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