ReportingService2005.GetReportParameters Méthode

Définition

Retourne des propriétés de paramètre de rapport pour un rapport spécifié. La méthode GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) peut également être utilisée pour valider des valeurs de paramètre d'après les paramètres d'un rapport spécifié.

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()

Paramètres

Report
String

Nom du chemin d'accès complet du rapport.

HistoryID
String

ID de l'instantané d'historique de rapport. Définissez le ForRendering paramètre sur une valeur de afin de récupérer les propriétés de true paramètre d’un instantané d’historique de rapport. Affectez une null (Nothing en Visual Basic) si vous récupérez des paramètres pour un rapport qui n'est pas un instantané d'historique de rapport.

ForRendering
Boolean

Expression Boolean qui indique comment doivent être utilisées les valeurs de paramètre. Si la valeur est true, les propriétés de paramètre retournées reposent sur les données de paramètre utilisées lors de l'exécution du rapport.

Values
ParameterValue[]

Valeurs de paramètre (objets ParameterValue) qui peuvent être validées d'après les paramètres d'un rapport géré par le serveur de rapports.

Credentials
DataSourceCredentials[]

Informations d'identification de source de données (objets DataSourceCredentials) qui peuvent être utilisées pour valider les paramètres de requête.

Retours

Tableau d'objets ReportParameter qui répertorie les paramètres pour le rapport.

Exemples

Pour compiler cet exemple de code, vous devez référencer le Reporting Services WSDL et importer certains espaces de noms. Pour plus d’informations, consultez Compilation et exécution d’exemples de code. L’exemple de code suivant utilise la GetReportParameters méthode pour récupérer une liste de métadonnées de paramètre pour un rapport, puis affiche le nom de chaque paramètre :

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());   
      }  
   }  
}  

Remarques

Le tableau suivant présente les informations relatives aux en-têtes et aux autorisations sur cette opération.

En-têtes SOAP (Out) ServerInfoHeaderValue
Autorisations requises ReadProperties

Si le paramètre d’exécution du rapport est Snapshot, les métadonnées de paramètre retournées sont les données utilisées lors de la création de l’historique du rapport instantané. Si le paramètre d’exécution du rapport est Live, les métadonnées de paramètre retournées représentent les données de paramètre associées au rapport spécifié.

Si vous fournissez une valeur pour le HistoryID paramètre et définissez la ForRendering valeur du paramètre sur true, les métadonnées de paramètre retournées représentent les données de paramètre qui ont été utilisées lors de la création de l’historique du rapport instantané. La valeur fournie pour HistoryID est ignorée si ForRendering a la valeur false. Si ForRendering a la valeur false, les métadonnées de paramètre retournées représentent les données de paramètre actuellement associées au rapport spécifié.

Si des valeurs de paramètres sont basées sur une requête et que vous souhaitez retourner la liste des valeurs valides des paramètres basés sur la requête, définissez ForRenderingtruesur . En outre, pour les paramètres basés sur une requête, vous devez transmettre toutes les informations d’identification requises pour retourner les paramètres de requête.

Lorsque vous utilisez la GetReportParameters méthode pour valider des paramètres, le Values paramètre est obligatoire.

Si les paramètres de rapport n’existent pas pour le rapport donné, un tableau vide ReportParameter est retourné.

S’applique à