LoadStdToolBitMap Method (IMAGELIST)

PLBCMP GUI Only

The LoadStdToolBitMap method retrieves the runtime default images for the TOOLBAR object into an IMAGELIST object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An IMAGELIST object into which the images are stored.

return

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

Flags Affected: EOS, OVER, ZERO

Note the following:

1. This method allows inclusion of both the default images and specialized images into an IMAGELIST object for use in a program.

2. Upon completion, {return} will contain the status of the method as follows. $FALSE is defined in PLBEQU.INC.

 

Value	Constant	The retrieval ...
0	$FALSE	was successful.
-1		failed.

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

4. If the {return} variable is overflowed, the OVER condition flag is set.

5. The EOS flag is always cleared.

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

7. The execution of the LoadStdToolBitmap method destroys the currently created IMAGELIST and fill it with the default images and specialized images from the runtime resources. After the LoadStdToolBitmap method has successfully executed, the newly created IMAGELIST object has the properties implicitly set by the method as follows:

 

MASKCOLOR=0xC0C0C0

USECOLORMASK=1

USEMASK=1

IMAGEHEIGHT=16

IMAGEWIDTH=16

8. When using the PL/B Web Server, this method sets the URLSOURCE property of the IMAGELIST to the 'plbtools.bmp' image name. The 'plbtools.bmp' must exist in the 'c:\sunbelt\plbwebsrv.xxx\http_root' directory where 'xxx' represents the PWS version being used.

See Also: Method Syntax, IMAGELIST Methods