L_BM_SAVE
Send this message to save an L_BITMAPCLASS window's bitmap to a file.
|
Parameter |
Meaning |
|
wParam |
Reserved. Set to NULL |
|
lParam |
Points to a LEADBITMAPSAVE structure. For a description, refer to the LEADBITMAPSAVE Structure described below. |
Returns
|
SUCCESS |
Function was successful. |
|
< 0 |
An error occurred. Refer to Return Codes. |
LEADBITMAPSAVE Structure
The L_BM_SAVE message lets you save an image in the L_BITMAPCLASS registered class. Before sending the message, your program must declare a LEADBITMAPSAVE structure and update its required fields. The following table describes the fields in the structure, using SavFile as the name of the LEADBITMAPSAVE structure.
|
Sample Field Name |
Data Type |
Description |
|
SavFile.uStructSize |
Size of the LEADBITMAPSAVE structure. This field allows for compatibility with future enhancements. It can be specified as follows: SavFile.uStructSize = sizeof(SavFile); | |
|
SavFile.Name |
L_TCHAR [L_MAXPATH] |
An array of length L_MAXPATH that holds the full path and name of the file to save. |
|
SavFile.Format |
The format of the file to save. For valid values, refer to Formats of Output Files. | |
|
SavFile.QFactor |
The Q factor to be used if the image is saved as a compressed file. The value can range from 2 to 255 for any of the LEAD, JTIF, or JFIF compression types. For additional valid values, refer to Compression Quality Factors. | |
|
SavFile.BitsPerPixel |
Number of bits per pixel. For valid values, refer to Formats of Output Files. | |
|
SavFile.pOptions |
Pointer to optional extra save options. Use NULL for defaults. |