Oc_getscannerinitinfo -31 – Rockwell Automation 1747-PCINT API Software for 1746 I/O User Manual

Page 85

Advertising
background image

OC_GetScannerInitInfo

Library of Routines

6–31

Publication 1747-6.5.3 June 1998

OC_GetScannerInitInfo

This function retrieves current information about the shared memory partitioning.

Syntax:

int

OC_GetScannerInitInfo(HANDLE handle, OCINIT *scaninit);

Parameters:

Description:

If the scanner has not been initialized, OC_GetScannerInitInfo returns an error.

If the scanner has been previously initialized, an application can retrieve the current scanner partitioning
information with this function instead of resetting and re-initializing the scanner.

The

OCINIT

structure us defined as:

typedef struct tagOCINIT
{

WORD

OutputImageSize;

/* size in bytes */

WORD

InputImageSize;

/* size in bytes */

WORD

HostRetentiveDataSize;

/* size in bytes */

} OCINIT;

Return Value:

Considerations:

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

Parameter:

Description:

handle

Must be a valid handle returned from OC_OpenScanner

scaninit

Points to the structure that contains the initialization information this
function returns

Name:

Value:

Description:

SUCCESS

0

scanner initialization information was retrieved successfully

ERR_OCACCESS

2

handle

does not have access to the scanner

ERR_OCINIT

5

scanner has not been initialized, see OC_InitScanner

ERR_OCPOST

7

scanner POST failed, see OC_GetScannerStatus

Advertising
This manual is related to the following products: