This topic has not yet been rated - Rate this topic

ReportingService2006.GetReportParameters Method

SQL Server 2005

Returns report parameter properties for a specified report. The GetReportParameters method can also be used to validate parameter values against parameters for a specified report.

Namespace: ReportService2006
Assembly: ReportService2006 (in reportservice2006.dll)

Syntax

C++

public ReportParameter[] GetReportParameters (
	string Report,
	string HistoryID,
	ParameterValue[] Values,
	DataSourceCredentials[] Credentials
)

public ReportParameter[] GetReportParameters (
	String Report, 
	String HistoryID, 
	ParameterValue[] Values, 
	DataSourceCredentials[] Credentials
)

JScript

public function GetReportParameters (
	Report : String, 
	HistoryID : String, 
	Values : ParameterValue[], 
	Credentials : DataSourceCredentials[]
) : ReportParameter[]

Parameters

Report: The fully qualified URL of the report including the file name and .rdl file name extension.

HistoryID: The ID of the report history snapshot. Set the ForRendering parameter to a value of true in order to retrieve parameter properties for a report history snapshot. Set the value to null (Nothing in Visual Basic) if you are retrieving parameters for a report that is not a report history snapshot.

Values: The parameter values (ParameterValue objects) that can be validated against the parameters of a report.

Credentials: The data source credentials (DataSourceCredentials objects) that can be used to validate query parameters.

Return Value

An array of ReportParameter objects that lists the parameters for the report.

Remarks

If the execution setting for the report is Snapshot, the parameter metadata that is returned is the data that was used when the report history snapshot was created. If the execution setting for the report is Live, the parameter metadata returned represents the parameter data that is associated with the specified report.

If you provide a value for the HistoryID parameter and set the ForRendering parameter value to true, the parameter metadata returned represents the parameter data that was used when the report history snapshot was created. The value supplied for HistoryID is ignored if ForRendering is set to false. If ForRendering is false, the parameter metadata returned represents the parameter data that is currently associated with the specified report.

If any parameters values are based on a query and you are interested in returning the query-based parameters' valid values list, set ForRendering to true. In addition, for query-based parameters, you must pass in all the credential information that is required to return the query parameters.

When using the GetReportParameters method to validate parameters, the ParameterValues parameter is required.

If report parameters do not exist for the given report, an empty ReportParameter array is returned.

Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
{
    static void Main(string[] args)
    {
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" +
            "ReportService2006.asmx";
        rs.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        string report = "http://<Server Name>/Docs/Documents" +
            "/AdventureWorks Sample Reports/" +
            "Employee Sales Summary.rdl";
        string historyID = null;
        ParameterValue[] values = null;
        DataSourceCredentials[] credentials = null;
        ReportParameter[] parameters = null;

        try
        {
            parameters = rs.GetReportParameters(report, historyID, 
                values, credentials);

            if (parameters != null)
            {
                foreach (ReportParameter rp in parameters)
                {
                    Console.WriteLine("Name: {0}", rp.Name);
                }
            }
        }
        catch (SoapException e)
        {
            Console.WriteLine(e.Detail.InnerXml.ToString());
        }
    }
}

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

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

Reference

ReportingService2006 Class
ReportingService2006 Members
ReportService2006 Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD