ReplaceBmp Method (IMAGELIST)


PLBCMP GUI Only

 

The ReplaceBmp method exchanges an image in an IMAGELIST object with an image from a bitmap. The method uses the following format:

 

[label]

{object}.ReplaceBmp

[GIVING {return}] USING [*Index=]{index}:

 

 

[*Bmp=]{bmp}[,[*Mask=]{mask}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. An IMAGELIST object in which an image is replaced.

return

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

index

Required. A decimal number or Numeric Variable that indicates the zero-based image to replace.

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. Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

  2.  

    Value

    Constant

    The replacement ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

 

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

  2. The OVER and EOS Condition Flags are always cleared.

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

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

 

 

See Also: Method Syntax, IMAGELIST Methods

 



PL/B Language Reference RemoveAll Method (IMAGELIST) ReplaceIcon Method (IMAGELIST)