Language

ReportingService2010.GetItemParameters メソッド

定義

指定されたアイテムのパラメータプロパティを返します。この方法は、指定された項目のパラメータ値とパラメータの検証にも使用できます。

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

パラメーター

ItemPath
String

項目の完全限定URLと、ファイル名、SharePointモードでは拡張子を含みます。

HistoryID
String

アイテム履歴のスナップショットのID。 ForRenderingパラメータをtrueに設定して、アイテム履歴スナップショットのパラメータプロパティを取得します。 アイテム履歴スナップショットでないアイテムのパラメータを取得する場合は、値をnull(Visual BasicでNothing)に設定してください。

ForRendering
Boolean

パラメータ値の使い方を示す Boolean 式です。 trueの値に設定された場合、返されるパラメータプロパティは、アイテムの実行時に使用されたパラメータデータに基づいています。

Values
ParameterValue[]

レポートサーバーが管理するアイテムのパラメータに対して検証可能なパラメータ値(ParameterValue オブジェクト)。

Credentials
DataSourceCredentials[]

クエリパラメータの検証に使用できるデータソースの認証情報(DataSourceCredentials オブジェクト)。

返品

アイテムのパラメータを一覧にする ItemParameter オブジェクトの配列です。

属性

例

このコード例をコンパイルするには、Reporting Services WSDLを参照し、特定の名前空間をインポートする必要があります。 詳細については 、「コード例のコンパイルと実行」をご覧ください。 以下のコード例では、 GetItemParameters メソッドを用いてレポートのパラメータメタデータのリストを取得し、各パラメータの名前を表示します。

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

注釈

以下の表は、この操作のヘッダーおよび権限情報を示しています。

SOAPヘッダーの使用 (イン) TrustedUserHeaderValue

(アウト) ServerInfoHeaderValue
ネイティブモードの必要権限 ReadProperties
SharePointモードの必要権限 <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems>

アイテムの実行設定が Snapshotの場合、返されるパラメータメタデータはアイテム履歴スナップショット作成時に使用されたデータです。 アイテムの実行設定が Liveされている場合、パラメータメタデータは指定されたアイテムに関連付けられたパラメータデータを表します。

HistoryIDパラメータの値を指定し、ForRenderingパラメータ値をtrueに設定すると、返されるパラメータメタデータはアイテム履歴スナップショット作成時に使用されたパラメータデータを表します。 HistoryIDに提供された値はForRenderingがfalseに設定されている場合は無視されます。ForRenderingがfalseの場合、返されるパラメータメタデータは指定されたアイテムに現在関連付けられているパラメータデータを表します。

クエリに基づくパラメータ値がいて、クエリベースのパラメータの有効値リストを返したい場合、 ForRendering を trueに設定してください。 さらに、クエリベースのパラメータでは、クエリパラメータを返すために必要なすべての認証情報を入力する必要があります。

パラメータ検証に GetItemParameters 法を使用する場合、 Values パラメータが必要です。

与えられたアイテムのパラメータが存在しない場合は、空の ItemParameter 配列が返されます。

適用対象