Publication 1756-RM004B-EN-P - October 2000
CIP Messaging API 4-5
Initialization
MVIcip_Open
Syntax:
int MVIcip_Open(MVIHANDLE *apiHandle);
Parameters:
apiHandle pointer to variable of type MVIHANDLE
Description:
MVIcip_Open acquires access to the CIP Messaging API and sets
apiHandle to a unique ID that the application uses in subsequent
functions. This function must be called before any of the other CIP API
functions can be used.
Return Value:
MVI_SUCCESS API was opened successfully
MVI_ERR_REOPEN API is already open
MVI_ERR_NODEVICE backplane driver could not be accessed
Note:
MVI_ERR_NODEVICE will be returned if the backplane device
driver is not loaded.
Example:
MVIHANDLE apiHandle;
if (MVIcip_Open(&apiHandle)!= MVI_SUCCESS)
{
printf (“Open failed!\n”);
}
else
{
printf (“Open succeeded\n”);
}
See Also:
MVIcip_Close
IMPORTANT
Once the API has been opened, MVIcip_Close
should always be called before exiting the
application.