Rockwell Automation Allen-Bradley ControlLogix 1756-MVI Programming Reference Manual page 48

3-26 MVI Backplane API
Publication 1756-RM004B-EN-P - October 2000
MVIbp_SetModuleStatus
Syntax:
int MVIbp_SetModuleStatus(MVIHANDLE handle, int status);
Parameters:
handle handle returned by previous call to MVIbp_Open
status module status, OK or Faulted
Description:
MVIbp_SetModuleStatus allows an application set the state of the
module to OK or Faulted. handle must be a valid handle returned from
MVIbp_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.
Note: The MVI hardware can set the OK LED to Red if any of the
following occurs:
• an unrecoverable fault
• hardware failure
• backplane driver failure
Neither the MVI hardware nor the Set ModuleStatus call has priority.
Either can overwrite the other.
Return Value:
MVI_SUCCESS
MVI_ERR_NOACCESS
MVI_ERR_BADPARAM
Example:
MVIHANDLE Handle;
/* Set the Status indicator to Red */
MVIbp_SetModuleStatus(Handle, MVI_MODULE_STATUS_FAULTED);
the input scan has occurred.
handle does not have access
lednum or ledstate is invalid.