BitmapDataFactoryBeginLoad(Stream, WorkingColorSpace, AsyncConfig) Method

public static IAsyncResult BeginLoad(
	Stream stream,
	WorkingColorSpace workingColorSpace,
	AsyncConfig? asyncConfig = null
)

Public Shared Function BeginLoad ( 
	stream As Stream,
	workingColorSpace As WorkingColorSpace,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
static IAsyncResult^ BeginLoad(
	Stream^ stream, 
	WorkingColorSpace workingColorSpace, 
	AsyncConfig^ asyncConfig = nullptr
)

static member BeginLoad : 
        stream : Stream * 
        workingColorSpace : WorkingColorSpace * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

stream  Stream

The stream to load the bitmap data from.

workingColorSpace  WorkingColorSpace

Specifies the preferred color space that should be used when working with the loaded bitmap data.
See the Remarks section of the WorkingColorSpace enumeration for more details.

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

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

To finish the operation and to get the exception that occurred during the operation you have to call the EndLoad 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