ParallelHelperBeginSortTKey, TValue(ArraySectionTKey, ArraySectionTValue, IComparerTKey, AsyncConfig) Method

public static IAsyncResult BeginSort<TKey, TValue>(
	ArraySection<TKey> keys,
	ArraySection<TValue> values,
	IComparer<TKey>? comparer = null,
	AsyncConfig? asyncConfig = null
)

Public Shared Function BeginSort(Of TKey, TValue) ( 
	keys As ArraySection(Of TKey),
	values As ArraySection(Of TValue),
	Optional comparer As IComparer(Of TKey) = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
generic<typename TKey, typename TValue>
static IAsyncResult^ BeginSort(
	ArraySection<TKey> keys, 
	ArraySection<TValue> values, 
	IComparer<TKey>^ comparer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

static member BeginSort : 
        keys : ArraySection<'TKey> * 
        values : ArraySection<'TValue> * 
        ?comparer : IComparer<'TKey> * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _comparer = defaultArg comparer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

keys  ArraySectionTKey

The ArraySectionT that contains the keys to sort.

values  ArraySectionTValue

The ArraySectionT that contains the values that correspond to the keys in the keys collection. If the IsNull property of values is , then only the keys are sorted.

comparer  IComparerTKey  (Optional)

The IComparerT implementation to use when comparing elements, or to use a default comparer. This parameter is optional.
Default value: .

asyncConfig  AsyncConfig  (Optional)

An optional configuration to adjust parallelization or cancellation. Reporting progress is not supported in sorting methods. This parameter is optional.
Default value: .

Type Parameters

TKey

The type of the elements in the keys collection.

TValue

The type of the elements in the values collection.

Return Value

In .NET Framework 4.0 and above you can use also the SortAsync methods.

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

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Reference