ReportingService2010.GetItemParameters Méthode

Définition

Retourne des propriétés de paramètre pour un élément spécifié. Cette méthode peut également être utilisée pour valider des valeurs de paramètre d’après les paramètres d’un élément spécifié.

public:
 cli::array <ReportService2010::ItemParameter ^> ^ GetItemParameters(System::String ^ ItemPath, System::String ^ HistoryID, bool ForRendering, cli::array <ReportService2010::ParameterValue ^> ^ Values, cli::array <ReportService2010::DataSourceCredentials ^> ^ Credentials);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetItemParameters", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
public ReportService2010.ItemParameter[] GetItemParameters (string ItemPath, string HistoryID, bool ForRendering, ReportService2010.ParameterValue[] Values, ReportService2010.DataSourceCredentials[] Credentials);
[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetItemParameters", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
member this.GetItemParameters : string * string * bool * ReportService2010.ParameterValue[] * ReportService2010.DataSourceCredentials[] -> ReportService2010.ItemParameter[]
Public Function GetItemParameters (ItemPath As String, HistoryID As String, ForRendering As Boolean, Values As ParameterValue(), Credentials As DataSourceCredentials()) As ItemParameter()

Paramètres

ItemPath
String

URL complète de l'élément, y compris le nom du fichier et, en mode SharePoint, l'extension.

HistoryID
String

ID de l'instantané d'historique d'élément. 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 d’élément. Affectez une null (Nothing en Visual Basic) si vous récupérez des paramètres pour un élément qui n'est pas un instantané d'historique d'élément.

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 de l'élément.

Values
ParameterValue[]

Valeurs de paramètre (objets ParameterValue) qui peuvent être validées d'après les paramètres d'un élément 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 ItemParameter qui répertorie les paramètres pour l'élément.

Attributs

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 GetItemParameters 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 ReportingService2010()  
      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 ItemParameter() = Nothing  

      Try  
         parameters = rs.GetItemParameters(report, historyID, forRendering, values, credentials)  

         If Not (parameters Is Nothing) Then  
            Dim rp As ItemParameter  
            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()  
   {  
      ReportingService2010 rs = new ReportingService2010();  
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;  

      string report = "/SampleReports/Employee Sales Summary";  
      bool forRendering = false;  
      string historyID = null;  
      ParameterValue[] values = null;  
      DataSourceCredentials[] credentials = null;  
      ItemParameter[] parameters = null;  

      try  
      {  
         parameters = rs.GetItemParameters(report, historyID, forRendering, values, credentials);  

         if (parameters != null)  
         {  
            foreach (ItemParameter 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.

Utilisation de l’en-tête SOAP (In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue
Autorisations requises en mode natif ReadProperties
Autorisations requises en mode SharePoint <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems>

Si le paramètre d’exécution de l’élément 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 de l’élément instantané. Si le paramètre d’exécution de l’élément est Live, les métadonnées de paramètre retournées représentent les données de paramètre associées à l’élément spécifié.

Si vous fournissez une valeur pour le HistoryID paramètre et que vous définissez la valeur du ForRendering paramètre surtrue, 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 d’élément 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 à l’élément 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 ForRendering sur true. 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 GetItemParameters méthode pour valider des paramètres, le Values paramètre est obligatoire.

S’il n’existe pas de paramètres pour l’élément donné, un tableau vide ItemParameter est retourné.

S’applique à