ReportExecutionService.Sort Method

Definition

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

public:
 int Sort(System::String ^ SortItem, ReportExecution2005::SortDirectionEnum Direction, bool Clear, [Runtime::InteropServices::Out] System::String ^ % ReportItem, [Runtime::InteropServices::Out] int % NumPages);
public int Sort (string SortItem, ReportExecution2005.SortDirectionEnum Direction, bool Clear, out string ReportItem, out int NumPages);
member this.Sort : string * ReportExecution2005.SortDirectionEnum * bool * string * int -> int
Public Function Sort (SortItem As String, Direction As SortDirectionEnum, Clear As Boolean, ByRef ReportItem As String, ByRef NumPages As Integer) 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.

ReportItem
String

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

NumPages
Int32

[out] The new total number of pages in the report.

Returns

An integer value containing 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