Rockwell Automation 1747-PCIS API Software - Open Controller - Manual (Page 97)

Publication 1747-UM002A-US-P - June 2000
Library of Routines 6-37
Return Value:
Considerations:
Supported in the DOS API library and the Windows NT API library
Example:
HANDLE Handle;
BYTE jmpr;
int retcode;
retcode = OC_GetUserJumperState( Handle, &jmpr );
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.
Name: Value: Description:
SUCCESS 0 switch position was read successfully
ERR_OCACCESS 2 handle does not have access to scanner
ERR_OCINIT 5 scanner has not been initialized, see OC_InitScanner
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)