BitmapDecoder.GetFrameAsync(UInt32) Method

Definition

Asynchronously retrieves a frame from the image file.

public:
 virtual IAsyncOperation<BitmapFrame ^> ^ GetFrameAsync(unsigned int frameIndex) = GetFrameAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<BitmapFrame> GetFrameAsync(uint32_t const& frameIndex);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<BitmapFrame> GetFrameAsync(uint frameIndex);
function getFrameAsync(frameIndex)
Public Function GetFrameAsync (frameIndex As UInteger) As IAsyncOperation(Of BitmapFrame)

Parameters

frameIndex
UInt32

unsigned int

uint32_t

The zero-based index of the frame to be retrieved.

Returns

Object that manages the asynchronous retrieval of the frame.

Attributes

Remarks

You don't need to use this method to access data from the first frame in an image file. BitmapDecoder already provides a method to access the first frame.

You can get the total number of frames on the image using the FrameCount property.

Applies to