RtecatDestroyMainDevice
RtecatDestroyMainDevice destroys a MainDevice.
Syntax
RTECAT_ERROR RtecatDestroyMainDevice(
[in] RTECAT_HANDLE MainDevice
);Parameters
[in] MainDevice
A handle to a MainDevice. To retrieve the corresponding handle, use RtecatOpenMainDevice.
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. |
|
ecatErrWrongParameter |
Parameter MainDevice is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice instance does not exist. |
Remarks
RtecatDestroyMainDevice is a synchronous function that executes immediately and returns a result upon completion.
When a MainDevice is destroyed, all associated handles, such as an axis handle, derived from that MainDevice become invalid. Nevertheless, it's still recommended to use RtecatCloseHandle to explicitly close these handles before using RtecatDestroyMainDevice.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtecatApi.h |
RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS) |
See Also:
