FormToPict Method (WINDOW)

PLBCMP GUI Only

The FormToPict method stores the contents of a WINDOW or PANEL object into a PICT object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A WINDOW object that is accessed.

pict

Optional. A PICT object that receives the current contents of a visible Window or Panel object.

handle

Optional. A decimal number or Numeric Variable that is a valid Window or Panel handle.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The {pict} object is destroyed before the new picture is stored.

2. If the HWND parameter is not specified, the current Window is stored.

3. If the value of {handle} is zero, the Windows desktop is stored.

4. When the {handle} parameter is specified, the value must be a valid Window or Panel handle. This parameter value retrieves the contents of the specified Window or Panel.

5. The EOS, OVER, and ZERO flags are always cleared.

6. The method does not transfer any data into the PICT return object when the Window is not activated or if the Window has been minimized. If no data is retrieved, the PICT object is not created after the method is completed. The user can use a 'MOVE PICT to PICT1' operation to determine if the picture is created after the method has completed.

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

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

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

See Also: Method Syntax, WINDOW Methods