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

Publication 1756-RM004B-EN-P - October 2000
4-30 CIP Messaging API
MVIcip_SetUserLED
Syntax:
int MVIcip_SetUserLED(MVIHANDLE handle, int lednum, int
ledstate);
Parameters:
handle handle returned by previous call to MVIcip_Open
lednum specifies which of the user LED indicators is being
addressed
ledstate specifies state for LED indicator
Description:
MVIcip_SetUserLED allows an application to turn the user LED
indicators on and off.
handle must be a valid handle returned from
MVIcip_Open.
lednum must be set to MVI_LED_USER1 or MVI_LED_USER2 to select
User LED 1 or User LED 2, respectively.
ledstate must be set to MVI_LED_STATE_ON or MVI_LED_STATE_OFF
to turn the indicator On or Off, respectively.
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;
/* Turn User LED 1 on and User LED 2 off */
MVIcip_SetUserLED(Handle, MVI_LED_USER1, MVI_LED_STATE_ON);
MVIcip_SetUserLED(Handle, MVI_LED_USER2, MVI_LED_STATE_OFF);