Langue

ReportingService2005.GetReportParameters Méthode

Définition

Rend les résultats des propriétés des paramètres pour un rapport spécifié. La GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) méthode peut également être utilisée pour valider les valeurs des paramètres par rapport aux 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

Le nom complet du parcours du rapport.

HistoryID
String

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

ForRendering
Boolean

Une Boolean expression qui indique comment les valeurs des paramètres doivent être utilisées. Si elle est définie à une valeur de true, les propriétés des paramètres retournées sont basées sur les données de paramètres utilisées lors de l’exécution du rapport.

Values
ParameterValue[]

Les valeurs des paramètres (ParameterValue objets) peuvent être validées par rapport aux paramètres d’un rapport géré par le serveur de rapports.

Credentials
DataSourceCredentials[]

Les identifiants de la source de données (DataSourceCredentials objets) qui peuvent être utilisés pour valider les paramètres de requête.

Retours

Un tableau d’objets ReportParameter qui liste les paramètres du rapport.

Exemples

Pour compiler cet exemple de code, vous devez référencer le WSDL de Reporting Services et importer certains espaces de noms. Pour plus d’informations, voir Exemples de compilation et exécution de code. L’exemple de code suivant utilise la GetReportParameters méthode pour récupérer une liste de métadonnées de paramètres 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 ci-dessous présente les informations sur l’en-tête et les autorisations concernant cette opération.

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

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

Si vous fournissez une valeur pour le HistoryID paramètre et que vous définissez la ForRendering valeur du paramètre à true, les métadonnées du paramètre retournées représentent les données de paramètre utilisées lors de la création de l’instantané de l’historique du rapport. La valeur fournie pour HistoryID est ignorée si ForRendering est défini à false. Si ForRendering est 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 de valeurs valides des paramètres de requête, définissez ForRendering à true. De plus, pour les paramètres basés sur la requête, vous devez transmettre toutes les informations d’identifiants nécessaires pour retourner les paramètres de requête.

Lors de l’utilisation de la GetReportParameters méthode pour valider les paramètres, le Values paramètre est requis.

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

S’applique à