ReportExecutionService.Sort2 Method (String, SortDirectionEnum, Boolean, PageCountMode, String, ExecutionInfo2)

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 Sort2(
    string SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    PageCountMode PaginationMode,
    out string ReportItem,
    out ExecutionInfo2 ExecutionInfo
)

public:
int Sort2(
    String^ SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    PageCountMode PaginationMode,
    [OutAttribute] String^% ReportItem,
    [OutAttribute] ExecutionInfo2^% ExecutionInfo
)

member Sort2 : 
        SortItem:string *
        Direction:SortDirectionEnum *
        Clear:bool *
        PaginationMode:PageCountMode *
        ReportItem:string byref *
        ExecutionInfo:ExecutionInfo2 byref -> int

Public Function Sort2 (
    SortItem As String,
    Direction As SortDirectionEnum,
    Clear As Boolean,
    PaginationMode As PageCountMode,
    <OutAttribute> ByRef ReportItem As String,
    <OutAttribute> ByRef ExecutionInfo As ExecutionInfo2
) 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.

• PaginationMode
  Type: ReportExecution2005.PageCountMode

  The mode by which the report is processed.

• ReportItem
  Type: System.String

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

• ExecutionInfo
  Type: ReportExecution2005.ExecutionInfo2

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

Return Value

Type: System.Int32

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.

See Also

ReportExecutionService Class
ReportExecution2005 Namespace

Return to top