ReportExecutionService.Sort Method

Article
12/03/2008

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

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSExecutionService2005
Assembly: ReportExecution2005 (in reportexecutionservice.dll)

Syntax

'Declaration
<SoapHeaderAttribute("ExecutionHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction:=SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function Sort ( _
    SortItem As String, _
    Direction As SortDirectionEnum, _
    Clear As Boolean, _
    <OutAttribute> ByRef ReportItem As String, _
    <OutAttribute> ByRef NumPages As Integer _
) As Integer

[SoapHeaderAttribute("ExecutionHeaderValue")] 
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out)] 
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public int Sort (
    string SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    out string ReportItem,
    out int NumPages
)

[SoapHeaderAttribute(L"ExecutionHeaderValue")] 
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction=SoapHeaderDirection::Out)] 
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse::Literal, ParameterStyle=SoapParameterStyle::Wrapped)] 
public:
int Sort (
    String^ SortItem, 
    SortDirectionEnum Direction, 
    bool Clear, 
    [OutAttribute] String^% ReportItem, 
    [OutAttribute] int% NumPages
)

/** @attribute SoapHeaderAttribute("ExecutionHeaderValue") */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) */ 
public int Sort (
    String SortItem, 
    SortDirectionEnum Direction, 
    boolean Clear, 
    /** @attribute OutAttribute() */ /** @ref */ String ReportItem, 
    /** @attribute OutAttribute() */ /** @ref */ int NumPages
)

JScript does not support passing value-type arguments by reference.

Parameters

SortItem
The ID of the report item on which to sort.

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

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

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

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

Return Value

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms