Sprache

ReportingService2005.GetReportParameters Methode

Definition

Die Rückgaben melden Parametereigenschaften für einen bestimmten Bericht. Die Methode GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) kann auch verwendet werden, um Parameterwerte mit Parametern für einen bestimmten 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 des Berichtsverlaufs-Snapshots. Setzen Sie den Parameter ForRendering auf einen Wert von ein true , um Parametereigenschaften für einen Berichtsverlauf-Snapshot abzurufen. Setze den Wert auf null (Nothingin Visual Basic), wenn du Parameter für einen Bericht abrufst, der kein Berichtsverlauf-Snapshot ist.

ForRendering
Boolean

Ein Boolean Ausdruck, der angibt, wie die Parameterwerte verwendet werden sollen. Wenn auf einen Wert von truegesetzt, 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 gegen die Parameter eines Berichts validiert werden können, der vom Berichtsserver verwaltet wird.

Credentials
DataSourceCredentials[]

Die Datenquellenzugangsdaten (DataSourceCredentials Objekte), die zur Validierung von Abfrageparametern verwendet werden können.

Gibt zurück

Ein Array von ReportParameter Objekten, das die Parameter für den Bericht auflistet.

Beispiele

Um dieses Codebeispiel zu kompilieren, müssen Sie auf die Reporting Services WSDL zurückgreifen und bestimmte Namensräume importieren. Weitere Informationen finden Sie unter Beispiele für Kompilierung und Ausführung von Coden. Das folgende Codebeispiel verwendet die Methode GetReportParameters , um eine Liste von Parametermetadaten für einen Bericht abzurufen und zeigt dann den Namen jedes Parameters an:

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

Die untenstehende Tabelle zeigt Header- und Berechtigungsinformationen zu dieser Operation.

SOAP-Überschriften (Aus) ServerInfoHeaderValue
Erforderliche Berechtigungen ReadProperties

Wenn die Ausführungseinstellung für den Bericht lautet Snapshot, sind die zurückgegebenen Parametermetadaten die Daten, die bei der Erstellung des Berichtsverlauf-Snapshots verwendet wurden. Wenn die Ausführungseinstellung für den Bericht lautet Live, repräsentieren die zurückgegebenen Parameter-Metadaten die Parameterdaten, die mit dem angegebenen Bericht verknüpft sind.

Wenn Sie einen Wert für den Parameter HistoryID angeben und den ForRendering Wert auf truesetzen, repräsentieren die zurückgegebenen Parameter-Metadaten die Parameterdaten, die bei der Erstellung des Berichtsverlauf-Snapshots verwendet wurden. Der für angegebene HistoryID Wert wird ignoriert, wenn ForRendering auf falsegesetzt ist. Wenn ForRendering , falserepräsentieren die zurückgegebenen Parameter-Metadaten die Parameterdaten, die derzeit mit dem angegebenen Bericht verknüpft sind.

Wenn irgendwelche Parameterwerte auf einer Abfrage basieren und Sie daran interessiert sind, die gültige Werteliste der fragebasierten Parameter zurückzugeben, setzen ForRendering Sie auf true. Zusätzlich müssen Sie bei fragebasierten Parametern alle erforderlichen Zugangsdaten für die Rückgabe der Abfrageparameter eingeben.

Bei der Verwendung der Methode GetReportParameters zur Validierung von Parametern ist der Parameter Values erforderlich.

Wenn für den gegebenen Bericht keine Berichtsparameter existieren, wird ein leeres ReportParameter Array zurückgegeben.

Gilt für: