BitmapDataExtensionsBeginGetColors Method

public static IAsyncResult BeginGetColors(
	this IReadableBitmapData bitmapData,
	int maxColors = 0,
	bool forceScanningContent = false,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginGetColors ( 
	bitmapData As IReadableBitmapData,
	Optional maxColors As Integer = 0,
	Optional forceScanningContent As Boolean = false,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginGetColors(
	IReadableBitmapData^ bitmapData, 
	int maxColors = 0, 
	bool forceScanningContent = false, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginGetColors : 
        bitmapData : IReadableBitmapData * 
        ?maxColors : int * 
        ?forceScanningContent : bool * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _maxColors = defaultArg maxColors 0
        let _forceScanningContent = defaultArg forceScanningContent false
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

bitmapData  IReadableBitmapData

The IReadableBitmapData, whose colors have to be returned. If it is indexed and the forceScanningContent parameter is , then its palette entries are returned and maxColors is ignored.

maxColors  Int32  (Optional)

A limit of the returned colors. If forceScanningContent parameter is , then this parameter is ignored for indexed bitmaps. Use 0 for no limit. This parameter is optional.
Default value: 0.

forceScanningContent  Boolean  (Optional)

to force scanning the actual image content even if the specified bitmapData is indexed and has a palette. This parameter is optional.
Default value: .

asyncConfig  AsyncConfig  (Optional)

The configuration of the asynchronous operation such as cancellation, reporting progress, etc. When Progress is set in this parameter, then this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface. This parameter is optional.
Default value: .

Return Value

Usage Note

In .NET Framework 4.0 and above you can use also the GetColorsAsync method.

To get the result or the exception that occurred during the operation you have to call the EndGetColors method.

This method is not a blocking call, though the operation is not parallelized and the MaxDegreeOfParallelism property of the asyncConfig parameter is ignored.

Reference