WriteImageListBmp Method (TOOLBAR)

9.1C, PLBCMP GUI Only

The WriteImageListBmp method allows imagelists for a TOOLBAR to be written to BMP image files. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A TOOLBAR object that is modified.

return

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

filename

Required. A Character String Variable or literal that identifies a BMP file to be written.

type

Optional. A numeric variable or decimal value that gives a value to identify the type of imagelist to be retrieved.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO flag is set when the {return} value is zero. The {return} value is zero when the method execution is successful. If the {return} value is non-zero, the method has failed.

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

3. The following {type} values identify the TOOLBAR imagelist to be written:

 

Value	ImageList used
0	standard (default)
1	disabled
2	hot

 

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

 

Code	Meaning
1	failed.
2	was successful
3	An error occurred while restoring the color mask for the requested 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.

 

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

See Also: Method Syntax, TOOLBAR Methods