IG_info_get

This function obtains information about the specified file page, without loading the pixel data.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_info_get_ex( const LPSTR lpszFileName, UINT nPageNumber, LPAT_MODE lpFileType, LPAT_MODE lpCompression, HIGDIBINFO* lphDIB );

Arguments:

Name	Type	Description
lpszFileName	const LPSTR	Path and name of the file to get the information about. The path can be absolute or relative.
nPageNumber	UINT	Page number to get info about if this is a multi-page (multi-image) file. Note that page numbers begin at 1, not 0. Set nPageNumber to 1, if this is not a multi-page file.
lpFileType	LPAT_MODE	Pointer to an AT_MODE variable in which the file type will be returned. See enumIGFormats for possible values.
lpCompression	LPAT_MODE	Pointer to an AT_MODE variable in which compression type will be returned. See enumIGCompressions for possible values.
lphDIB	HIGDIBINFO*	Pointer to an HIGDIBINFO structure to which additional file information such as width, height, and Bits Per Pixel, will be returned.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Example:

	Copy Code
AT_MODE nFileType; // Will receive an IG_FORMAT_ constant AT_MODE nCompression; // Will receive an IG_COMPRESSION_ constant HIGDIBINFO hDIB; AT_ERRCOUNT nErrcount; // Returned count of errors nErrcount = IG_info_get_ex("picture.bmp", 1, &nFileType, &nCompression, &hDIB); // ... // Delete DIB info IG_DIB_info_delete(hDIB);

Copy Code

AT_MODE nFileType;        // Will receive an IG_FORMAT_ constant
AT_MODE nCompression;    // Will receive an IG_COMPRESSION_ constant
HIGDIBINFO hDIB;
AT_ERRCOUNT nErrcount;        // Returned count of errors
nErrcount = IG_info_get_ex("picture.bmp", 1, &nFileType, &nCompression, &hDIB);

// ...
// Delete DIB info
IG_DIB_info_delete(hDIB);

Remarks:

Any of the output parameters such as lpFileType, lpCompression or lphDIB can be NULL, if the corresponding info is not required.

See also the section Loading and Saving.

This function is identical to IG_fltr_pageinfo_get_ex.