PixelDataProvider.DetachPixelData PixelDataProvider.DetachPixelData PixelDataProvider.DetachPixelData PixelDataProvider.DetachPixelData PixelDataProvider.DetachPixelData Method

Definition

Returns the internally-stored pixel data.

public : byte[] DetachPixelData()
byte[] DetachPixelData() const;
public byte[] DetachPixelData()
Public Function DetachPixelData() As byte[]
var byte[] = pixelDataProvider.detachPixelData();

Returns

byte[] 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.