Langage

ReportingService2010.GetItemParameters Méthode

Définition

Restitue les propriétés des paramètres pour un élément spécifié. Cette méthode peut également être utilisée pour valider les valeurs des paramètres par rapport aux 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

L’URL entièrement qualifiée de l’élément incluant le nom du fichier et, en mode SharePoint, l’extension.

HistoryID
String

L’ID de l’instantané de l’historique de l’article. Fixez 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 d’élément. Définissez la valeur à null (Nothing dans Visual Basic) si vous récupérez des paramètres pour un élément qui n’est pas un instantané d’historique d’objet.

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ètre utilisées lors de l’exécution de l’élément.

Values
ParameterValue[]

Les valeurs des paramètres (ParameterValue objets) qui peuvent être validées par rapport aux paramètres d’un élément 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 ItemParameter qui liste les paramètres de l’élément.

Attributs

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 GetItemParameters 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 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 ci-dessous présente les informations sur l’en-tête et les autorisations concernant cette opération.

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

(Dehors) ServerInfoHeaderValue
Mode natif : autorisations requises ReadProperties
Permissions 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 du paramètre retournées correspondent aux données utilisées lors de la création de l’instantané de l’historique de l’élément. Si le paramètre d’exécution de l’élément est Live, les métadonnées du 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 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 de l’article. 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 à 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 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 GetItemParameters méthode pour valider les paramètres, le Values paramètre est requis.

Si les paramètres n’existent pas pour l’élément donné, un tableau vide ItemParameter est retourné.

S’applique à