GET PICTURE FROM LIBRARY

GET PICTURE FROM LIBRARY ( picRef | picName ; picture )

Parameter	Type		Description
picRef | picName	Longint, String	→	Reference number of Picture Library graphic or Name of Picture Library graphic
picture	Picture	←	Picture from the Picture Library

This command is not thread-safe, it cannot be used in preemptive code.

Description

The GET PICTURE FROM LIBRARY command returns in the picture parameter the Picture Library graphic whose reference number is passed in picRef or whose name is passed in picName.

If there is no picture with that reference number or name, GET PICTURE FROM LIBRARY leaves picture unchanged.

Example 1

The following example returns in vgMyPicture the picture whose reference number is stored in the local variable $vlPicRef:

 GET PICTURE FROM LIBRARY($vlPicRef;vgMyPicture)

Example 2

The following example returns in $DDcom_Prot_MyPicture the picture with the name "DDcom_Prot_Button1" stored in the Picture Library:

 GET PICTURE FROM LIBRARY("DDcom_Prot_Button1";$DDcom_Prot_MyPicture)

Example 3

See the third example for the PICTURE LIBRARY LIST command.

System variables and sets

If the Picture Library exists, the OK variable is set to 1. Otherwise, OK is set to zero.

Error management

If there is not enough memory to return the picture, an error -108 is generated. You can catch this error using an error-handling method.

See also

PICTURE LIBRARY LIST
REMOVE PICTURE FROM LIBRARY
SET PICTURE TO LIBRARY