AddBmp Method (IMAGELIST)

PLBCMP GUI Only

The AddBmp method inserts a bitmap image to an IMAGELIST object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An IMAGELIST object to which the image is added.

return

Optional. A Numeric Variable that returns the zero-based index of the new image.

bmp

Required. A Character String Variable or Numeric Variable that specifies the file name or resource number of the new image.

mask

Optional. A Character String Variable or Numeric Variable that specifies the file name or resource number of the image mask.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. If the method is successful, the zero-based index of the new image is returned. If the method is not successful, {return} will contain a negative one.

2. If the bitmap image is smaller than the IMAGESIZEH or IMAGESIZEV property, the image is not added and {return} will contain a negative one.

3. If the bitmap image is wider than the IMAGESIZEH property setting, it is split up and added as multiple images.

4. When a masked image is drawn, the specified {mask} is combined with the image to produce transparent areas in the bitmap allowing the background color to show.

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

6. If {return} is too small to contain the new image index, the OVER Condition Flag is set.

7. The EOS Condition Flag is always cleared.

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

9. A {bmp} resource number value of zero causes the imagelist picture to be loaded from the clipboard.

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

See Also: Method Syntax, IMAGELIST Methods