ImgXBeginWrite

HANDLE IMAPI ImgXBeginWrite (lpFile, lpDIB, hOptBlk, lpInfo)

This function is used to begin exporting an image.

Parameter

Type

Description

lpFile

LPSTR

Points to ASCII string containing name of file to save the image in.

lpDIB

LPBITMAPINFO

Points to a BITMAPINFO struct which defines the image.

hOptBlk

HANDLE

Handle to an option block for this image. If this is NULL, ImageMan will assume logical defaults.

lpInfo

LPXINFO

Points to an XINFO struct defining the export procedure for this image.

Return Value

The return value is the handle to use when referencing this export job in future ImageMan functions; it is NULL if an error occurred.

Comments

This is the function which initiates the export of an image. Before calling this function, you should create an OptBlk with the desired options (or leave this NULL), Fill in the XINFO struct pointed to by lpInfo with the desired values, and determine the name of the file you will be exporting. This may be done through the OptBlk or by filling in the lpFileName parameter; if the lpFileName parameter exists, it will supersede a filename in an OptBlk.

Parameter	Type	Description
lpFile	LPSTR	Points to ASCII string containing name of file to save the image in.
lpDIB	LPBITMAPINFO	Points to a BITMAPINFO struct which defines the image.
hOptBlk	HANDLE	Handle to an option block for this image. If this is NULL, ImageMan will assume logical defaults.
lpInfo	LPXINFO	Points to an XINFO struct defining the export procedure for this image.