This function loads a raster image from a BMP file.
[C++Builder/Visual
C++] HANDLE IKBmpFileLoad(LPCTSTR
FileName, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message,
LPCTSTR Button);
[Delphi] function
IKBmpFileLoad(FileName: PChar; UserProc: LONG_PTR; Caption,
Message, Button: PChar): THandle;
[Visual Basic] Function
IKBmpFileLoad(ByVal FileName As String, ByVal UserProc As Long,
ByVal Caption As String, ByVal Message As String, ByVal Button As
String) As Long
Parameters
| Name | Explanation |
|---|---|
| FileName | The name of the image file that is loaded |
| 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 the image handle of the raster image if successful. Returns 0 if unsuccessful.
Explanation
The IKBmpFileLoad function loads a raster image from a BMP file. Supports 1, 4, 8, 16, 24, and 32 bit color images.
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.