RtecatCloseHandle

RtecatCloseHandle closes an E-CAT handle.

Syntax

RTECAT_ERROR RtecatCloseHandle(
  [in]    RTECAT_HANDLE Handle
);

Parameters

[in] Handle

An E-CAT handle (e.g., MainDevice, SubDevice, axis or module handles).

Return Values

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

Remarks

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

When a MainDevice handle is closed, all associated handles, such as an axis handle derived from that MainDevice, become invalid. However, we recommend you use RtecatCloseHandle to explicitly close these handles before closing the MainDevice handle.

Requirements

See Also:

• RTECAT_ERROR
• RTECAT_HANDLE
• RtecatOpenAxisByIndex
• RtecatOpenAxisByLocation
• RtecatOpenMainDevice