ReportingService2005.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 propriedades do parâmetro do relatório para um relatório especificado. O GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) método também pode ser usado para validar valores de parâmetros em relação a parâmetros para 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 completo do caminho do relatório.
- HistoryID
- String
O ID do snapshot do histórico de relatórios. Defina o ForRendering parâmetro para um valor de true para recuperar propriedades de parâmetros para um snapshot do histórico do relatório. Defina o valor para null (Nothing no Visual Basic) se você estiver recuperando parâmetros para um relatório que não seja um snapshot do histórico do relatório.
- ForRendering
- Boolean
Uma Boolean expressão que indica como os valores dos parâmetros devem ser usados. Se definido para um valor de true, as propriedades dos parâmetros retornadas são baseadas nos dados do parâmetro usados durante a execução do relatório.
- Values
- ParameterValue[]
Os valores dos parâmetros (ParameterValue objetos) que podem ser validados em relação aos parâmetros de um relatório gerenciado pelo servidor de relatórios.
- Credentials
- DataSourceCredentials[]
As credenciais da fonte de dados (DataSourceCredentials objetos) que podem ser usadas para validar parâmetros de consulta.
Retornos
Um array de ReportParameter objetos que lista os parâmetros do relatório.
Exemplos
Para compilar esse exemplo de código, você deve consultar o Reporting Services WSDL e importar certos namespaces. Para mais informações, veja Exemplos de Código Compilando e Executando. O exemplo de código a seguir usa o GetReportParameters método para recuperar uma lista de metadados de parâmetros para um relatório e então 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 abaixo mostra informações sobre cabeçalhos e permissões sobre esta operação.
| Cabeçalhos SOAP | (Fora) ServerInfoHeaderValue |
| Permissões necessárias | ReadProperties |
Se a configuração de execução do relatório for Snapshot, os metadados do parâmetro retornados são os dados usados quando o snapshot do histórico do relatório foi criado. Se a configuração de execução do relatório for Live, os metadados do parâmetro retornados representam os dados do parâmetro associados ao relatório especificado.
Se você fornecer um valor para o HistoryID parâmetro e definir o ForRendering valor do parâmetro para true, os metadados do parâmetro retornados representam os dados do parâmetro usados quando o snapshot do histórico do relatório foi criado. O valor fornecido para HistoryID é ignorado se ForRendering for definido como false. Se ForRendering for false, os metadados do parâmetro retornados representam os dados do parâmetro atualmente associados ao relatório especificado.
Se algum valor de parâmetro for baseado em uma consulta e você estiver interessado em retornar a lista de valores válidos dos parâmetros baseados em consulta, defina ForRendering para true. Além disso, para parâmetros baseados em consulta, você deve passar todas as informações de credenciais necessárias para devolver os parâmetros da consulta.
Ao usar o GetReportParameters método para validar parâmetros, o Values parâmetro é necessário.
Se os parâmetros do relatório não existirem para o relatório dado, um array vazio ReportParameter é retornado.