Library.CloseHandle Method

Closes an open E-CAT handle. When a MainDevice handle is closed, all handles derived from it become invalid.

Namespace:  IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly:  IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.1.0)

Syntax

Copy
public EcatErrorCode CloseHandle(
    EcatHandle handle
)

Parameters

handle

Type: EcatHandle
An open E-CAT handle.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code Meaning

ecatErrNoError

The function succeeded.

Remarks

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 CloseHandle to explicitly close these handles before closing the MainDevice handle.

See Also: