ReportExecutionService.Sort Method (String, SortDirectionEnum, Boolean, String, Int32)

Applies To: SQL Server 2016 Preview

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

Namespace:   ReportExecution2005
Assembly:  ReportExecution2005 (in ReportExecution2005.dll)

Syntax

public int Sort(
    string SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    out string ReportItem,
    out int NumPages
)

public:
int Sort(
    String^ SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    [OutAttribute] String^% ReportItem,
    [OutAttribute] int% NumPages
)

member Sort : 
        SortItem:string *
        Direction:SortDirectionEnum *
        Clear:bool *
        ReportItem:string byref *
        NumPages:int byref -> int

Public Function Sort (
    SortItem As String,
    Direction As SortDirectionEnum,
    Clear As Boolean,
    <OutAttribute> ByRef ReportItem As String,
    <OutAttribute> ByRef NumPages As Integer
) As Integer

Parameters

• SortItem
  Type: System.String

  The ID of the report item on which to sort.

• Direction
  Type: ReportExecution2005.SortDirectionEnum

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

• Clear
  Type: System.Boolean

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

• ReportItem
  Type: System.String

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

• NumPages
  Type: System.Int32

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

Return Value

Type: System.Int32

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.

See Also

ReportExecutionService Class
ReportExecution2005 Namespace

Return to top