ReportingService2010.GetItemParameters メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定したアイテムのパラメーター プロパティを返します。このメソッドは、指定したアイテムのパラメーターに対するパラメーター値を検証するために使用することもできます。
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
ファイル名と拡張子 (SharePoint モードの場合) を含む、アイテムの完全修飾 URL です。
- 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 ヘッダーの使用方法 | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
ネイティブ モードで必要なアクセス許可 | ReadProperties |
SharePoint モードで必要なアクセス許可 | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
アイテムの実行設定が Snapshot
の場合は、アイテム履歴スナップショットが作成されたときに使用されたデータがパラメーター メタデータとして返されます。 アイテムの実行設定が Live
の場合、返されるパラメーター メタデータは、指定したアイテムに関連付けられたパラメーター データを表します。
パラメーターの値を指定し、パラメーター値HistoryID
を ForRendering
にtrue
設定した場合、返されるパラメーター メタデータは、アイテム履歴スナップショットの作成時に使用されたパラメーター データを表します。 HistoryID
が false
に設定されている場合、ForRendering
で指定した値は無視されます。ForRendering
が false
の場合、返されるパラメーター メタデータは、指定したアイテムに現在関連付けられているパラメーター データを表します。
任意のパラメーター値がクエリに基づいており、クエリに基づいたパラメーターの有効な値の一覧を取得する場合は、ForRendering
を true
に設定します。 また、クエリに基づいたパラメーターには、クエリ パラメーターを返すために必要なすべての資格情報を渡す必要があります。
GetItemParameters メソッドを使用してパラメーターを検証する場合は、Values
パラメーターが必須です。
指定したアイテムにパラメーターが存在しない場合、空の ItemParameter 配列が返されます。