Destroy Method

Summary

Invalidates this RasterImageAnimator object and returns the animated image.

Syntax

C++

public RasterImage Destroy()

Public Function Destroy() As RasterImage

public: 
RasterImage^ Destroy();

Return Value

A RasterImage object containing the multi-frame animated image.

Remarks

If you pass null (Nothing in VisualBasic) in the animatedImage parameter for the RasterImageAnimator constructor, you can use the Append method to add frames to the multi-frame image during the animation. This is useful if you want to play an animated file as it is being loaded. If you need to reference the multi-frame image after the animation, you can call the Destroy method before you dispose this RasterImageAnimator object.

After you call Destroy, this RasterImageAnimator object is invalid and you should only call the Dispose method afterwards.

Example

For an example, refer to Append.

Requirements

Target Platforms