ReportingService2006.GetReportParameters Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Retorna as propriedades de parâmetro de relatório para um relatório especificado. O método GetReportParameters(String, String, ParameterValue[], DataSourceCredentials[]) também pode ser usado para validar valores de parâmetro em relação aos parâmetros de um relatório especificado.
public:
cli::array <ReportService2006::ReportParameter ^> ^ GetReportParameters(System::String ^ Report, System::String ^ HistoryID, cli::array <ReportService2006::ParameterValue ^> ^ Values, cli::array <ReportService2006::DataSourceCredentials ^> ^ Credentials);
public ReportService2006.ReportParameter[] GetReportParameters (string Report, string HistoryID, ReportService2006.ParameterValue[] Values, ReportService2006.DataSourceCredentials[] Credentials);
member this.GetReportParameters : string * string * ReportService2006.ParameterValue[] * ReportService2006.DataSourceCredentials[] -> ReportService2006.ReportParameter[]
Public Function GetReportParameters (Report As String, HistoryID As String, Values As ParameterValue(), Credentials As DataSourceCredentials()) As ReportParameter()
Parâmetros
- Report
- String
A URL totalmente qualificada do relatório, incluindo o nome do arquivo e a extensão de nome de arquivo .rdl.
- HistoryID
- String
A ID do instantâneo de histórico de relatórios. Defina o ForRendering
parâmetro como um valor de true
para recuperar propriedades de parâmetro para um histórico de relatórios instantâneo. Defina o valor como null
(Nothing
no Visual Basic) se você estiver recuperando parâmetros de um relatório que não é um instantâneo de histórico de relatórios.
- Values
- ParameterValue[]
Os valores de parâmetro (objetos ParameterValue) que podem ser validados em relação aos parâmetros de um relatório.
- Credentials
- DataSourceCredentials[]
As credenciais de fonte de dados (objetos DataSourceCredentials) que podem ser usados para validar parâmetros de consulta.
Retornos
Uma matriz de objetos ReportParameter que lista os parâmetros do relatório.
Exemplos
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());
}
}
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols
Class Sample
Public Shared Sub Main()
Dim rs As New ReportingService2006()
rs.Url = "http://<Server Name>/_vti_bin/" + _
"ReportServer/ReportService2006.asmx"
rs.Credentials = _
System.Net.CredentialCache.DefaultCredentials
Dim report As String = "http://<Server Name>" + _
"/Docs/Documents/AdventureWorks Sample Reports" + _
"/Employee Sales Summary.rdl"
Dim historyID As String = Nothing
Dim values As ParameterValue() = Nothing
Dim credentials As DataSourceCredentials() = Nothing
Dim parameters As ReportParameter() = Nothing
Try
parameters = rs.GetReportParameters(report, historyID, _
values, credentials)
If Not (parameters Is Nothing) Then
Dim rp As ReportParameter
For Each rp In parameters
Console.WriteLine("Name: {0}", rp.Name)
Next rp
End If
Catch e As SoapException
Console.WriteLine(e.Detail.InnerXml.ToString())
End Try
End Sub
End Class
Comentários
A tabela a seguir mostra o cabeçalho e as informações de permissão sobre esta operação.
Cabeçalhos SOAP | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
Permissões necessárias | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
Se a configuração de execução do relatório for Snapshot
, os metadados de parâmetro retornados serão os dados que foram usados quando o histórico de relatórios instantâneo foi criado. Se a configuração de execução do relatório for Live
, os metadados de parâmetro retornados representarão os dados de parâmetro associados ao relatório especificado.
Se você fornecer um valor para o HistoryID
parâmetro e definir o valor do ForRendering
parâmetro como true
, os metadados de parâmetro retornados representarão os dados de parâmetro que foram usados quando o histórico de relatórios instantâneo foi criado. O valor fornecido para HistoryID
será ignorado se ForRendering
for definido false
como . Se ForRendering
for false
, os metadados de parâmetro retornados representam os dados de parâmetro associados ao relatório especificado no momento.
Se os valores de parâmetros forem baseados em uma consulta e você estiver interessado em retornar a lista de valores válidos dos parâmetros baseados em consulta, defina ForRendering
como true
. Além disso, para parâmetros baseados em consulta, você deve passar todas as informações de credencial necessárias para retornar os parâmetros de consulta.
Ao usar o GetReportParameters método para validar parâmetros, o Values
parâmetro é necessário.
Se os parâmetros de relatório não existirem para o relatório fornecido, uma matriz vazia ReportParameter será retornada.