Close Method (ANIMATE)


9.0, PLBCMP GUI Only

 

The Close method stops execution of an ANIMATE object. The method uses the following format:

 

[label]

{object}.Close

[GIVING {return}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. An ANIMATE object that is closed.

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 invokes the Close Event of the ANIMATE object.

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

  3.  

    Value

    Constant

    The method ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

     

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

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

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

 

 

See Also: Example Code, Method Syntax, ANIMATE Methods

 



PL/B Language Reference ANIMATE Methods Open Method (ANIMATE)