ReportExecutionService.Sort2 Method

Definition

Applies or removes a sort for the execution based on a user sort action.

public:
 int Sort2(System::String ^ SortItem, ReportExecution2005::SortDirectionEnum Direction, bool Clear, ReportExecution2005::PageCountMode PaginationMode, [Runtime::InteropServices::Out] System::String ^ % ReportItem, [Runtime::InteropServices::Out] ReportExecution2005::ExecutionInfo2 ^ % ExecutionInfo);
public int Sort2 (string SortItem, ReportExecution2005.SortDirectionEnum Direction, bool Clear, ReportExecution2005.PageCountMode PaginationMode, out string ReportItem, out ReportExecution2005.ExecutionInfo2 ExecutionInfo);
member this.Sort2 : string * ReportExecution2005.SortDirectionEnum * bool * ReportExecution2005.PageCountMode * string * ExecutionInfo2 -> int
Public Function Sort2 (SortItem As String, Direction As SortDirectionEnum, Clear As Boolean, PaginationMode As PageCountMode, ByRef ReportItem As String, ByRef ExecutionInfo As ExecutionInfo2) As Integer

Parameters

SortItem
String

The ID of the report item on which to sort.

Direction
SortDirectionEnum

A SortDirectionEnum value containing the direction for the sort. The default value is None.

Clear
Boolean

A Boolean value that indicates whether all other existing sorts should be cleared. The default is false.

PaginationMode
PageCountMode

The mode by which the report is processed.

ReportItem
String

[out] The ID of the item on the page used for positioning in the viewing area.

ExecutionInfo
ExecutionInfo2

[out] An ExecutionInfo object containing information about the report execution.

Returns

An integer value that contains the new page number on which the item passed in the ReportItem parameter falls.

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage (In) TrustedUserHeaderValue

(In) ExecutionHeaderValue

(Out) ServerInfoHeaderValue
Native Mode Required Permissions None
SharePoint Mode Required Permissions None

Applies to