RtfwecatDeleteInstance

RtfwecatDeleteInstance deletes an E-CAT MainDevice instance.

Syntax

Copy
bool RtfwecatDeleteInstance(
    [in]    unsigned int Instance
);

Parameters

[in] Instance

The instance number to delete, in the range 0-62.

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

The value of parameter Instance is outside the acceptable range (0-62).

ERROR_NOT_FOUND

The instance does not exist.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwecatApi.h

RtfwecatApi.lib

See Also: