Oc_getuserjumper state, Oc_getuserjumperstate -36, Return value: considerations – Rockwell Automation 1747-PCIS API Software - Open Controller User Manual

Page 96: Example, Syntax, Parameters: description

Advertising
background image

Publication 1747-UM002A-US-P - June 2000

6-36 Library of Routines

Return Value:

Considerations:

Supported in the DOS API library and the Windows NT API library

Example:

HANDLE

Handle;

BYTE

temp;

int

retcode;

retcode = OC_GetTemperature( Handle, &temp );

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.

Name:

Value:

Description:

SUCCESS

0

temperature 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

jmpr

If

jmpr

is:

JUMPER_PRESENT

jumper is installed

JUMPER_ABSENT

jumper is not installed

Advertising
This manual is related to the following products: