Rockwell Automation 1747-PCINT API Software for 1746 I/O - Manual (Page 97)

OC_GetUserLEDState Library of Routines 6–43
Publication 1747-6.5.3 June 1998
OC_GetUserLEDState OC_GetUserLEDState reads the status of one of the four user-defined LEDs.
Syntax:
int OC_GetUserLEDState(HANDLE handle, int lednum, int *state);
Parameters:
Description:
The application can use this function to determine the current state of the LEDs.
Return Value:
Considerations:
Supported in the DOS API library and the Windows NT API library
Example:
HANDLE Handle;
int led_state;
int retcode;
retcode = OC_GetUserLEDState( Handle, 1, &led_state );
Parameter: Description:
handle Must be a valid handle returned from OC_OpenScanner
lednum
Must be a value from 1 to 4, which corresponds to LED 1, LED 2, LED 3,
and LED 4
state
If state is:
LED_OFF LED is off
LED_RED_SOLID LED is on, red solid
LED_GREEN_SOLID LED is on, green solid
LED_RED_FLASH LED is on, red flashing (LED1 and LED2
only)
LED_GREEN_FLASH
LED is on, green flashing (LED1 and LED2
only)
Name: Value: Description:
SUCCESS
0
LED was read successfully
ERR_OCACCESS 2
handle does not have access to scanner