Stop Method (ANIMATE)

9.0, PLBCMP GUI Only

The Stop method halts playing an AVI file in an ANIMATE object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An ANIMATE object that is accessed.

return

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

Flags Affected: EOS, OVER, ZERO

Note the following:

1. A return value of zero (0) indicates success.

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

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

4. 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