WriteBmpFile Method (PICT)

9.1C, PLBCMP GUI Only

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

Where:

label

Optional. A Program Execution Label.

object

Required. A PICT 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 {return} value is zero when the method execution is successful. If the {return} value is non-zero, the WriteBmpFile method execution has failed.

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

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

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

 

Code	Meaning
-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.

6. This method is available under Windows CE. (9.5B)

7. This method is not available when using the PL/B Web Server.

See Also: Method Syntax, PICT Methods