WriteBmpFile Method (IMAGELIST)

9.1C, PLBCMP GUI Only

The WriteBmpFile method writes the IMAGELIST image into a BMP file. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An IMAGELIST object whose image is output.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

filename

Required. A character string variable or literal that identifies the BMP file to be written.

Flags Affected: OVER, ZERO

Note the following:

1. The IMAGELIST bmp image is written as an image strip where all of the images exist in a single image row. The image strip is required to ensure that this BMP file can be used in the ADDBMP or ADDBMPMASK methods to restore all of the imagelist images.

2. The {return} value is zero when the method execution is successful. If the {return} value is non-zero, the WriteBmpFile method execution has failed.

3. If the value returned is zero, the ZERO Condition Flag is set.

4. The OVER flag is set if the {return} variable is too small and the returned value is truncated.

5. The following {return} values describe possible error codes that can be returned by the WriteBmpFile method:

 

Code	Meaning
1	The imagelist does not contain an imagelist handle.
2	The imagelist does not contain any images.
3	An error occurred while restoring the color mask for the imagelist images.
4	The {filename} string name does contain any data.
5	Invalid imagelist image color bit count while extracting the image. Image color bit count must be 1, 4, 8, 16, 24 or 32.
6	Insufficient memory detected while building the image strip.
-1	Insufficient resources to process imagelist BMP data.
-3	Imagelist BMP data is not created and cannot be processed.
-6	Insufficient memory to process imagelist BMP data.
-103	Unable to create/access the BMP file specified by the FILENAME parameter.
-104	Unable to write the BITMAPFILEHEADER data to the BMP file.
-105	Unable to write the BITMAPINFOHEADER and the RGBQUAD color table to the BMP file.
-106	Unable to write the BMP color pixel data to the BMP file.
-107	An error occurred while closing the BMP file.

 

6. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

7. This method is not supported by the PL/B Web Server.

See Also: Method Syntax, IMAGELIST Methods