Rockwell Automation Allen-Bradley ControlLogix 1756-MVI - Page 83

Publication 1756-RM004B-EN-P - October 2000
CIP Messaging API 4-31
MVIcip_SetModuleStatus
Syntax:
int MVIcip_SetModuleStatus(MVIHANDLE handle, int status);
Parameters:
handle handle returned by previous call to MVIcip_Open
status module status, OK or Faulted
Description:
MVIcip_SetModuleStatus allows an application set the status of the
module to OK or Faulted.
handle must be a valid handle returned from
MVIcip_Open.
status must be set to MVI_MODULE_STATUS_OK or
MVI_MODULE_STATUS_FAULTED. If the status is Ok, the module status
LED indicator will be set to Green. If the status is Faulted, the status
indicator will be set to Red.
Return Value:
MVI_SUCCESS the input scan has occurred.
MVI_ERR_NOACCESS
handle does not have access
MVI_ERR_BADPARAM
lednum or ledstate is invalid.
Example:
MVIHANDLE Handle;
/* Set the Status indicator to Red */
MVIcip_SetModuleStatus(Handle, MVI_MODULE_STATUS_FAULTED);