BitmapDataExtensionsBeginSave Method

Begins to save the content of this bitmapData into the specified stream asynchronously.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0

C#

public static IAsyncResult BeginSave(
	this IReadableBitmapData bitmapData,
	Stream stream,
	AsyncConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function BeginSave ( 
	bitmapData As IReadableBitmapData,
	stream As Stream,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

C++

public:
[ExtensionAttribute]
static IAsyncResult^ BeginSave(
	IReadableBitmapData^ bitmapData, 
	Stream^ stream, 
	AsyncConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member BeginSave : 
        bitmapData : IReadableBitmapData * 
        stream : Stream * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult

Parameters

bitmapData IReadableBitmapData: The IReadableBitmapData to save.
stream Stream: The stream to save the bitmap data into.
asyncConfig AsyncConfig (Optional): The configuration of the asynchronous operation such as parallelization, 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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadableBitmapData. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

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

To finish the operation and to get the exception that occurred during the operation you have to call the EndSave method.

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

Tip

See the Remarks section of the Save method for more details.