QueryPageGeneratorGetQueryPageResultInfoAsync Method

This is preliminary documentation and is subject to change.

Retrieve the basic information of the result set of the currently specified MediaWiki query page.

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0+bba8b7a48c3412988f4331f41f4164c670d73663

Syntax

C++

Copy

public Task<QueryPageResultInfo> GetQueryPageResultInfoAsync(
	CancellationToken cancellationToken = default
)

Public Function GetQueryPageResultInfoAsync ( 
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of QueryPageResultInfo)

Dim instance As QueryPageGenerator
Dim cancellationToken As CancellationToken

Dim returnValue As Task(Of QueryPageResultInfo)

returnValue = instance.GetQueryPageResultInfoAsync(cancellationToken)

public:
Task<QueryPageResultInfo^>^ GetQueryPageResultInfoAsync(
	CancellationToken cancellationToken = CancellationToken()
)

member GetQueryPageResultInfoAsync : 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<QueryPageResultInfo>

Parameters

cancellationToken CancellationToken (Optional): a token used to cancel the operation.

Return Value

TaskQueryPageResultInfo
a task that resolves into the query page result set information.

Exceptions

Exception	Condition
UnexpectedDataException	Received unexpected JSON data from MediaWiki server.

Remarks

To retrieve the items of the query page result set, use EnumItemsAsync(CancellationToken).

Reference

QueryPageGenerator Class

WikiClientLibrary.Generators Namespace