L_TwainGetAcquirePageOptions

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainGetAcquirePageOptions(hSession, pnPaperSize, pnPaperDirection)

HTWAINSESSION hSession;

/* handle to an existing TWAIN session */

L_INT * pnPaperSize;

/* pointer to a variable */

L_INT * pnPaperDirection;

/* pointer to a variable */

Gets the current page size, and page orientation values used when transferring images from the current TWAIN source.

Parameter

Description

hSession

Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession function.

pnPaperSize

Pointer to a variable to be updated with the page size. For more information on possible values, refer to www.twain.org and click on TWAIN Specification (Version 2.0).

pnPaperDirection

Pointer to a variable to be updated with the page direction. For more information on possible values, refer to www.twain.org and click on TWAIN Specification (Version 2.0).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function gets the current page size capability ICAP_SUPPORTEDSIZES, and page orientation capability ICAP_ORIENTATION values. For more information on these capabilities, refer to www.twain.org and click on TWAIN Specification (Version 2.0).

To set these capabilities, call the L_TwainSetAcquirePageOptions function.

This function should be called after calling the L_TwainStartCapsNeg function and before calling the L_TwainEndCapsNeg function.

Required DLLs and Libraries

LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_TwainSetTransferOptions, L_TwainGetTransferOptions, L_TwainGetSupportedTransferMode, L_TwainSetResolution, L_TwainGetResolution, L_TwainSetImageFrame, L_TwainGetImageFrame, L_TwainSetImageUnit, L_TwainGetImageUnit, L_TwainSetImageBitsPerPixel, L_TwainGetImageBitsPerPixel, L_TwainSetImageEffects, L_TwainGetImageEffects, L_TwainSetAcquirePageOptions, L_TwainSetRGBResponse, L_TwainShowProgress, L_TwainEnableDuplex, L_TwainGetDuplexOptions, L_TwainSetMaxXferCount, L_TwainGetMaxXferCount

Topics:

Getting and Setting Capabilities

 

TWAIN Functionality: Capability Functions

Example

For an example, refer to L_TwainGetImageEffects.