DTWAIN_GetImageInfoString

Top Previous Next

The DTWAIN_GetImageInfoString returns the description of the image data that is to be transferred from the Source.

DTWAIN_BOOL DTWAIN_GetImageInfoString (

DTWAIN_SOURCE	Source,
LPTSTR	pXResolution
LPTSTR	pYResolution
LPLONG	pWidth
LPLONG	pLength
LPLONG	pNumSamples
LPDTWAIN_ARRAY	pBitsPerSample
LPLONG	pBitsPerPixel
LPDTWAIN_BOOL	pPlanar
LPLONG	pPixelType
LPLONG	pCompression );

Parameters

Source

Specifies a TWAIN Source.

pXResolution

String buffer that will receive the X-resolution of the image, or NULL if this parameter is to be ignored.

pYResolution

String buffer that will receive the Y-resolution of the image, or NULL if this parameter is to be ignored

pWidth

Address of a LONG that will receive the image width, or NULL if this parameter is to be ignored

pLength

Address of a LONG that will receive the image length, or NULL if this parameter is to be ignored

pNumSamples

Address of a LONG that will receive the number of samples of the image, or NULL if this parameter is to be ignored

pBitsPerSample

Address of a DTWAIN_ARRAY that will store the number of bits for each sample, or NULL if this parameter is to be ignored.

pBitsPerPixel

Address of a LONG that will receive the number of bits per pixel, or NULL if this parameter is to be ignored

pPlanar

Address of a DTWAIN_BOOL that will receive the pixel order type, or NULL if this parameter is to be ignored.

pPixelType

Address of a LONG that will receive the color (pixel-type) of the image, or NULL if this parameter is to be ignored.

pCompression

Address of a LONG that will receive the image compression type, or NULL if this parameter is to be ignored.

Return Values

If the function succeeds, TRUE is returned. If the function fails, FALSE is returned.

Comments

The DTWAIN_GetImageInfoString function works exactly the same way as DTWAIN_GetImageInfo, with the exception of the LPTSTR parameters which are string buffers that will be filled on return with the values. See DTWAIN_GetImageInfo function for more details.

The LPTSTR arguments must point to a buffer large enough to hold the necessary string information. The string information will not exceed 255 characters.

TWAIN State Transitions

The source must be opened in State 6

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function

DTWAIN Acquisition Function