Miscellaneous Functions - Rockwell Automation Allen-Bradley ControlLogix 1756-MVI Programming Reference Manual

4-28 CIP Messaging API
Publication 1756-RM004B-EN-P - October 2000

Miscellaneous Functions

MVIcip_GetIdObject
Syntax:
int MVIcip_GetIdObject(MVIHANDLE apiHandle, MVICIPIDOBJ
*idobject);
Parameters:
apiHandle handle returned from MVIcip_Open call
Description:
MVIcip_GetIdObject retrieves the identity object for the module.
apiHandle must be a valid handle returned from MVIcip_Open.
idobject is a pointer to a structure of type MVICIPIDOBJ. The members
of this structure will be updated with the module identity data.
The MVICIPIDOBJ structure is defined below:
typedef struct tagMVICIPIDOBJ
{
WORD VendorID;
WORD DeviceType;
WORD ProductCode;
BYTE MajorRevision;
BYTE MinorRevision;
DWORD SerialNo;
BYTE Name[32];
} MVICIPIDOBJ;
Return Value:
MVI_SUCCESS ID
MVI_ERR_NOACCESS
Example:
MVIHANDLE apiHandle;
MVICIPIDOBJ idobject;
MVIcip_GetIdObject(apiHandle, &idobject);
printf("Module Name: %s Serial Number: %lu\n", idobject.Name,
idobject.SerialNo);
// Vendor ID number
// General product type
// Vendor-specific product identifier
// Major revision level
// Minor revision level
// Module serial number
// Text module name (null-terminated)
object was retrieved successfully
apiHandle does not have access