Oc_getuserjumper, State -42 – Rockwell Automation 1747-PCINT API Software for 1746 I/O User Manual

Page 96

Advertising
background image

6–42

Library of Routines

OC_GetUserJumper State

Publication 1747-6.5.3 June 1998

OC_GetUserJumper
State

OC_GetUserJumperState reads the state of the user selectable jumper.

Syntax:

int

OC_GetUserJumperState(HANDLE handle, BYTE *jmpr);

Parameters:

Description:

The scanner reads the state of the jumper once during its POST and does not continually monitor the state
of the jumper.

The scanner must be initialized before you can monitor the jumper position.

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 );

Parameter:

Description:

handle

Must be a valid handle returned from OC_OpenScanner

jmpr

If

jmpr

is:

JUMPER_PRESENT

jumper is installed

JUMPER_ABSENT

jumper is not installed

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

Advertising
This manual is related to the following products: