ProSoft Technology MVI69-ADM - Manual (Page 294)

CIP Messaging Library Functions MVI-ADM ♦ 'C' Programmable
Developer's Guide 'C' Programmable Application Development Module
Page 294 of 342 ProSoft Technology, Inc.
February 20, 2013
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);