RtfwecatGetInstance

RtfwecatGetInstance gets the current E-CAT MainDevice instance configuration.

Syntax

Copy

bool RtfwecatGetInstance(
    [in]    unsigned int Instance,
    [out]   RTFWECAT_INSTANCE_CONFIGURATION* pConfiguration
);

Parameters

[in] Instance

The instance number (0-62).

[out] pConfiguration

A pointer for the instance configuration to be written.

Return Value

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

Possible error codes:

Error code	Meaning
ERROR_INVALID_PARAMETER	One of the following conditions occurred: The value of parameter Instance is outside the acceptable range (0-62). Parameter pConfiguration is NULL.
ERROR_NOT_FOUND	The instance does not exist.

Error code

Meaning

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

ERROR_NOT_FOUND

The instance does not exist.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwecatApi.h	RtfwecatApi.lib