RtecatGetInstanceStatus

RtecatGetInstanceStatus gets an E-CAT MainDevice instance status.

Syntax

Copy

BOOL RtecatGetInstanceStatus(
  [out]   PRT_COMPONENT_STATUS pStatus,
  [in]    ULONG Instance
);

Parameters

[out] pStatus

A pointer for the status to be written.

[in] Instance

The instance to query. The maximum number of instances is 63 (0-62), as defined by RTECAT_MAX_INSTANCE in the header file.

Return Values

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code if the function fails.

Possible error codes:

Error codes	Meaning
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter pStatus is NULL. The value of parameter Instance is outside the acceptable range (0-62).

Error codes

Meaning

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

Requirements

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