ReportingService2005.GetReportParameters Methode

Definition

Gibt Berichtsparametereigenschaften für einen angegebenen Bericht zurück. Die GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[])-Methode kann auch verwendet werden, um Parameterwerte anhand von Parametern für einen angegebenen Bericht zu validieren.

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

Parameter

Report
String

Der vollständige Pfadname des Berichts.

HistoryID
String

Die ID der Berichtsverlaufs-Momentaufnahme. Legen Sie den ForRendering Parameter auf einen Wert von true fest, um Parametereigenschaften für einen Berichtsverlauf Momentaufnahme abzurufen. Legen Sie den Wert auf null (Nothing in Visual Basic) fest, wenn Sie Parameter für einen Bericht abrufen, der keine Berichtsverlaufs-Momentaufnahme ist.

ForRendering
Boolean

Ein Boolean-Ausdruck, der angibt, wie die Parameterwerte verwendet werden sollen. Wenn true festgelegt wurde, basieren die zurückgegebenen Parametereigenschaften auf den Parameterdaten, die während der Ausführung des Berichts verwendet wurden.

Values
ParameterValue[]

Die Parameterwerte (ParameterValue-Objekte), die für die Parameter eines Berichts, der vom Berichtsserver verwaltet wird, validiert werden können.

Credentials
DataSourceCredentials[]

Die Anmeldeinformationen für die Datenquelle (DataSourceCredentials-Objekte), mit denen Abfrageparameter validiert werden können.

Gibt zurück

Ein Array von ReportParameter-Objekten, das die Parameter für den Bericht aufführt.

Beispiele

Um dieses Codebeispiel zu kompilieren, müssen Sie auf die Reporting Services WSDL verweisen und bestimmte Namespaces importieren. Weitere Informationen finden Sie unter Kompilieren und Ausführen von Codebeispielen. Im folgenden Codebeispiel wird die GetReportParameters -Methode verwendet, um eine Liste der Parametermetadaten für einen Bericht abzurufen und dann den Namen der einzelnen Parameter anzuzeigen:

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

Hinweise

In der folgenden Tabelle werden Header- und Berechtigungsinformationen zu diesem Vorgang dargestellt.

SOAP-Header (Out) ServerInfoHeaderValue
Erforderliche Berechtigungen ReadProperties

Wenn die Ausführungseinstellung für den Bericht lautetSnapshot, sind die zurückgegebenen Parametermetadaten die Daten, die beim Erstellen des Berichtsverlaufs Momentaufnahme verwendet wurden. Wenn die Ausführungseinstellung für den Bericht lautet Live, stellen die zurückgegebenen Parametermetadaten die Parameterdaten dar, die dem angegebenen Bericht zugeordnet sind.

Wenn Sie einen Wert für den HistoryID Parameter angeben und den ForRendering Parameterwert auf truefestlegen, stellen die zurückgegebenen Parametermetadaten die Parameterdaten dar, die beim Erstellen des Berichtsverlaufs Momentaufnahme verwendet wurden. Der für HistoryID angegebene Wert wird ignoriert, wenn ForRendering auf falsefestgelegt ist. Wenn ForRendering ist false, stellen die zurückgegebenen Parametermetadaten die Parameterdaten dar, die derzeit dem angegebenen Bericht zugeordnet sind.

Wenn Parameterwerte auf einer Abfrage basieren und Sie daran interessiert sind, die Liste der gültigen Werte der abfragebasierten Parameter zurückzugeben, legen Sie auf fest ForRenderingtrue. Darüber hinaus müssen Sie für abfragebasierte Parameter alle Anmeldeinformationen übergeben, die zum Zurückgeben der Abfrageparameter erforderlich sind.

Wenn Sie die -Methode zum Überprüfen von GetReportParameters Parametern verwenden, ist der Values Parameter erforderlich.

Wenn für den angegebenen Bericht keine Berichtsparameter vorhanden sind, wird ein leeres ReportParameter Array zurückgegeben.

Gilt für: