IKBmpFileSaveMem

This function saves raster image data in BMP format as raw image data.

[C++Builder/Visual C++] BOOL IKBmpFileSaveMem(HANDLE InHandle, HANDLE *OutHandle, BOOL Comp, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message, LPCTSTR Button);

[Delphi] function IKBmpFileSaveMem(InHandle: THandle; var OutHandle: THandle; Comp: LongBool; UserProc: LONG_PTR; Caption, Message, Button: PChar): LongBool;

[Visual Basic] Function IKBmpFileSaveMem(ByVal InHandle As Long, OutHandle As Long, ByVal Comp As Long, ByVal UserProc As Long, ByVal Caption As String, ByVal Message As String, ByVal Button As String) As Long

Parameters

Name	Explanation
InHandle	The image handle of the raster image
OutHandle	The raw image data to be saved
Comp	Compression flag (False (0): Uncompressed, True (nonzero) Compressed) Only 4 bit color and 8 bit color images can be compressed
UserProc	The address of the user function (If not using the user function then set to 0)
Caption	Sets the text displayed in the title bar of the progress dialog box
Message	Sets the message displayed in the progress dialog box
Button	Sets the name of the button displayed in the progress dialog box

Return Value

Returns True (nonzero) if successful. Returns False (0) if unsuccessful.

Explanation

The IKBmpFileSaveMem function saves raster image data in BMP format as raw image data Supports 1, 4, 8, 16, 24, and 32 bit color images (Does not support 16 bit grayscale). When the Comp parameter is True, the ImageKit uses the Windows run-length compression format. However, there are cases, depending on the image, when the file is not compressed but rather enlarged. The ImageKit stops saving the image file if it enlarges by more than 1.6 times its original size and false (0) is returned.

If the user function is set or if the Caption, Message, and Button parameters are blank then the Progress dialog box is not displayed. If the Progress dialog box is displayed, it indicates the percentage of the current process completed. For more information about the user function please refer to the Definition of User Function in the Ik9File.dll, Ik9FileA.dll, Ik9File64.dll, and Ik9File64A.dll section.

Except for the fact that the raster image is saved as raw image data, this function operates in the same way as the IKBmpFileSave function.