ProSoft Technology MVI69-ADM User Manual

Page 274

Advertising
background image

CIP Messaging Library Functions

MVI-ADM ♦ 'C' Programmable

Developer's Guide

'C' Programmable Application Development Module

Page 274 of 342

ProSoft Technology, Inc.

February 20, 2013

MVIcip_UnregisterAssemblyObj

Syntax

int MVIcip_UnregisterAssemblyObj(MVIHANDLE handle, MVIHANDLE objHandle );

Parameters

handle

handle returned by previous call to MVIcip_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.

handle must be a valid handle returned from MVIcip_Open.

objHandle must be a handle returned from

MVIcip_RegisterAssemblyObj.

Return Value

MVI_SUCCESS

object was unregistered successfully

MVI_ERR_NOACCESS

handle does not have access

MVI_ERR_BADPARAM

objHandle is invalid

Example

MVIHANDLE handle;
MVIHANDLE objHandle;
// Unregister all instances of the object
MVIcip_UnregisterAssemblyObj(handle, objHandle );

See Also
MVIcip_RegisterAssemblyObj (page 272)

Advertising