ncCloseObject

Purpose

Close an object.

Format

NCTYPE_STATUS ncCloseObject(NCTYPE_OBJH ObjHandle)

Input

ObjHandle

Object handle.

Output

Return Value

Status of the function call, returned as a signed 32-bit integer. Zero means the function executed successfully. Negative specifies an error, meaning the function did not perform expected behavior. Positive specifies a warning, meaning the function performed as expected, but a condition arose that might require attention. For more information, refer to ncStatusToString.

Description

ncCloseObject closes an object when it no longer needs to be in use, such as when the application is about to exit. When an object is closed, NI-CAN stops all pending operations and clears RTSI configuration for the object, and you can no longer use the ObjHandle in the application.

Network Interface Object

ObjHandle refers to an open CAN or LIN Network Interface Object.

CAN Object

ObjHandle refers to an open CAN Object.