PixelDataProvider.DetachPixelData Method

Reference

Definition

Namespace:: Windows.Graphics.Imaging

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Returns the internally-stored pixel data.

public:
 virtual Platform::Array <byte> ^ DetachPixelData() = DetachPixelData;

winrt::array_view <byte> DetachPixelData();

public byte[] DetachPixelData();

function detachPixelData()

Public Function DetachPixelData () As Byte()

Returns

Byte[]

byte[]

The pixel data.

Remarks

PixelDataProvider doesn't retain a copy of the pixel data after a successful call to this method. This means that subsequent calls to the method will fail.

If you are using the Windows Runtime C++ Template Library (WRL), you are responsible for releasing the underlying memory for the pixel data. Call CoTaskMemFree after you are done with the data. If you are using a language projection such as C# or C++/WinRT, memory management is handled automatically.

The return value is an array of 8 bit unsigned values. However, depending on the requested pixel format, the pixel data may represent another type. For example, if the pixel format is Rgba16, then each color value is a 16 bit unsigned integer that takes up two 8 bit elements of the array. You must convert the array to the correct type before you use it.

Applies to