ProSoft Technology MVI56E-LDM - Manual (Page 88)

CIP API Functions ControlLogix Platform ♦ "C" Programmable
Developer's Manual Linux Application Development Module
Page 82 of 264 ProSoft Technology, Inc.
March 12, 2014
OCXcip_UnregisterAssemblyObj
Syntax
int OCXcip_UnregisterAssemblyObj(OCXHANDLE apihandle,
OCXHANDLE objHandle );
Parameters
apihandle handle returned by previous call to OCXcip_Open
objHandle handle for object to be unregistered
Description
This function is used by an application to unregister all instances of the Assembly
Object with the CIP API. Any current connections for the object specified by
objHandle
will be terminated.
apihandle
must be a valid handle returned from
OCXcip_Open
.
objHandle
must be a handle returned from
OCXcip_RegisterAssemblyObj
.
Return Value
OCX_SUCCESS object was unregistered successfully
OCX_ERR_NOACCESS apihandle does not have access
OCX_ERR_INVALID_OBJHANDLE objHandle is invalid
Example
OCXHANDLE apihandle;
OCXHANDLE objHandle;
// Unregister all instances of the object
OCXcip_UnregisterAssemblyObj(apihandle, objHandle );
See Also
OCXcip_RegisterAssemblyObj