ReportingService2005.GetReportParameters Método

Definição

Namespace:

ReportService2005

Assembly:

ReportService2005.dll

Retorna as propriedades de parâmetro de relatório para um relatório especificado. O método GetReportParameters(String, String, Boolean, 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 <ReportService2005::ReportParameter ^> ^ GetReportParameters(System::String ^ Report, System::String ^ HistoryID, bool ForRendering, cli::array <ReportService2005::ParameterValue ^> ^ Values, cli::array <ReportService2005::DataSourceCredentials ^> ^ Credentials);

public ReportService2005.ReportParameter[] GetReportParameters (string Report, string HistoryID, bool ForRendering, ReportService2005.ParameterValue[] Values, ReportService2005.DataSourceCredentials[] Credentials);

member this.GetReportParameters : string * string * bool * ReportService2005.ParameterValue[] * ReportService2005.DataSourceCredentials[] -> ReportService2005.ReportParameter[]

Public Function GetReportParameters (Report As String, HistoryID As String, ForRendering As Boolean, Values As ParameterValue(), Credentials As DataSourceCredentials()) As ReportParameter()

Parâmetros

Report

String

O nome do caminho completo do relatório.

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.

ForRendering

Boolean

Uma expressão Boolean que indica como os valores de parâmetros serão usados. Se o valor for definido como true, as propriedades de parâmetro retornadas terão como base os dados de parâmetro usados durante a execução do relatório.

Values

ParameterValue[]

Os valores de parâmetro (objetos ParameterValue) que podem ser validados em relação aos parâmetros de um relatório que é gerenciado pelo servidor de relatório.

Credentials

DataSourceCredentials[]

As credenciais de fonte de dados (objetos DataSourceCredentials) que podem ser usados para validar parâmetros de consulta.

Retornos

ReportParameter[]

Uma matriz de objetos ReportParameter que lista os parâmetros do relatório.

Exemplos

Para compilar esse exemplo de código, você deve referenciar o WSDL Reporting Services e importar determinados namespaces. Para obter mais informações, consulte Compilando e executando exemplos de código. O exemplo de código a seguir usa o GetReportParameters método para recuperar uma lista de metadados de parâmetro para um relatório e exibe o nome de cada parâmetro:

Imports System  
Imports System.Web.Services.Protocols  

Class Sample  
   Public Shared Sub Main()  
      Dim rs As New ReportingService2005()  
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials  

      Dim report As String = "/SampleReports/Employee Sales Summary"  
      Dim forRendering As Boolean = False  
      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, forRendering, 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 'Main  
End Class 'Sample  

using System;  
using System.Web.Services.Protocols;  

class Sample  
{  
   public static void Main()  
   {  
      ReportingService2005 rs = new ReportingService2005();  
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;  

      string report = "/SampleReports/Employee Sales Summary";  
      bool forRendering = false;  
      string historyID = null;  
      ParameterValue[] values = null;  
      DataSourceCredentials[] credentials = null;  
      ReportParameter[] parameters = null;  

      try  
      {  
         parameters = rs.GetReportParameters(report, historyID, forRendering, 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());   
      }  
   }  
}  

Comentários

A tabela a seguir mostra o cabeçalho e as informações de permissão sobre esta operação.

Cabeçalhos SOAP	(Out) ServerInfoHeaderValue
Permissões necessárias	ReadProperties

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 falsecomo . 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.