ReportingService2005.GetReportParameters Método

Definición

Espacio de nombres:

ReportService2005

Ensamblado:

ReportService2005.dll

Devuelve las propiedades de los parámetros de informe para un informe especificado. El método GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) también se puede usar para validar los valores de parámetro con los parámetros de un informe 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

Nombre de la ruta de acceso completa del informe.

HistoryID

String

Identificador de la instantánea del historial de informes. Establezca el ForRendering parámetro en un valor de para recuperar las propiedades de true parámetro de una instantánea del historial de informes. Establezca el valor en null (Nothing en Visual Basic) si va a recuperar los parámetros para un informe que no sea una instantánea del historial de informes.

ForRendering

Boolean

Expresión Boolean que indica cómo se van a usar los valores de los parámetros. Si está establecido en un valor true, las propiedades del parámetro que se devuelven se basan en los datos de los parámetros que se utilizaron durante la ejecución del informe.

Values

ParameterValue[]

Valores de los parámetros (objetosParameterValue) que se pueden validar con los parámetros de un informe que administra el servidor de informes.

Credentials

DataSourceCredentials[]

Credenciales del origen de datos (objetosDataSourceCredentials) que se pueden utilizar para validar los parámetros de la consulta.

Devoluciones

ReportParameter[]

Matriz de objetos ReportParameter que enumeran los parámetros para el informe.

Ejemplos

Para compilar este ejemplo de código, debe hacer referencia al Reporting Services WSDL e importar determinados espacios de nombres. Para obtener más información, vea Compilar y ejecutar ejemplos de código. En el ejemplo de código siguiente se usa el GetReportParameters método para recuperar una lista de metadatos de parámetros para un informe y, a continuación, se muestra el nombre 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());   
      }  
   }  
}  

Comentarios

En la siguiente tabla se muestra la información de encabezado y de permisos de esta operación.

Encabezados SOAP	(Out) ServerInfoHeaderValue
Permisos necesarios	ReadProperties

Si la configuración de ejecución del informe es Snapshot, los metadatos de parámetro que se devuelven son los datos que se usaron cuando se creó la instantánea del historial de informes. Si la configuración de ejecución del informe es Live, los metadatos del parámetro devueltos representan los datos de parámetro asociados al informe especificado.

Si proporciona un valor para el HistoryID parámetro y establece el valor truedel ForRendering parámetro en , los metadatos del parámetro devueltos representan los datos de parámetro que se usaron cuando se creó la instantánea del historial de informes. El valor proporcionado para HistoryID se omite si ForRendering se establece en false. Si ForRendering es false, los metadatos del parámetro devueltos representan los datos de parámetro que están asociados actualmente al informe especificado.

Si algún valor de parámetros se basa en una consulta y está interesado en devolver la lista de valores válidos de los parámetros basados en consultas, establezca en ForRenderingtrue. Además, para los parámetros basados en consultas, debe pasar toda la información de credenciales necesaria para devolver los parámetros de consulta.

Cuando se usa el GetReportParameters método para validar parámetros, se requiere el Values parámetro .

Si los parámetros de informe no existen para el informe determinado, se devuelve una matriz vacía ReportParameter .