ReportingService2006.GetReportParameters メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定されたレポートのパラメータプロパティを報告します。 GetReportParameters(String, String, ParameterValue[], DataSourceCredentials[])メソッドは、指定されたレポートのパラメータに対してパラメータ値を検証するためにも使用できます。
public:
cli::array <ReportService2006::ReportParameter ^> ^ GetReportParameters(System::String ^ Report, System::String ^ HistoryID, cli::array <ReportService2006::ParameterValue ^> ^ Values, cli::array <ReportService2006::DataSourceCredentials ^> ^ Credentials);
public ReportService2006.ReportParameter[] GetReportParameters(string Report, string HistoryID, ReportService2006.ParameterValue[] Values, ReportService2006.DataSourceCredentials[] Credentials);
member this.GetReportParameters : string * string * ReportService2006.ParameterValue[] * ReportService2006.DataSourceCredentials[] -> ReportService2006.ReportParameter[]
Public Function GetReportParameters (Report As String, HistoryID As String, Values As ParameterValue(), Credentials As DataSourceCredentials()) As ReportParameter()
パラメーター
- Report
- String
ファイル名と拡張子.rdlを含む、レポートの完全修飾URLを記載してください。
- HistoryID
- String
レポート履歴のIDスナップショット。 レポート履歴スナップショットのパラメータプロパティを取得するために、 ForRendering パラメータを true に設定します。 レポート履歴スナップショットでないレポートのパラメータを取得する場合は、値をnull(Visual BasicではNothing)に設定してください。
- Values
- ParameterValue[]
レポートのパラメータに対して検証可能なパラメータ値(ParameterValue オブジェクト)。
- Credentials
- DataSourceCredentials[]
クエリパラメータの検証に使用できるデータソースの認証情報(DataSourceCredentials オブジェクト)。
返品
レポートのパラメータを一覧にする ReportParameter オブジェクトの配列です。
例
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;
class Sample
{
static void Main(string[] args)
{
ReportingService2006 rs = new ReportingService2006();
rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" +
"ReportService2006.asmx";
rs.Credentials =
System.Net.CredentialCache.DefaultCredentials;
string report = "http://<Server Name>/Docs/Documents" +
"/AdventureWorks Sample Reports/" +
"Employee Sales Summary.rdl";
string historyID = null;
ParameterValue[] values = null;
DataSourceCredentials[] credentials = null;
ReportParameter[] parameters = null;
try
{
parameters = rs.GetReportParameters(report, historyID,
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());
}
}
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols
Class Sample
Public Shared Sub Main()
Dim rs As New ReportingService2006()
rs.Url = "http://<Server Name>/_vti_bin/" + _
"ReportServer/ReportService2006.asmx"
rs.Credentials = _
System.Net.CredentialCache.DefaultCredentials
Dim report As String = "http://<Server Name>" + _
"/Docs/Documents/AdventureWorks Sample Reports" + _
"/Employee Sales Summary.rdl"
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, _
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
End Class
注釈
以下の表は、この操作のヘッダーおよび権限情報を示しています。
| SOAPヘッダー | (イン) TrustedUserHeaderValue (アウト) ServerInfoHeaderValue |
| 必要なアクセス許可 | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
レポートの実行設定が Snapshotの場合、返されるパラメータメタデータはレポート履歴スナップショット作成時に使用されたデータです。 レポートの実行設定が Liveされている場合、返されるパラメータメタデータは指定されたレポートに関連付けられたパラメータデータを表します。
HistoryIDパラメータの値を指定し、ForRenderingパラメータの値をtrueに設定すると、返されるパラメータメタデータはレポート履歴スナップショット作成時に使用されたパラメータデータを表します。
HistoryIDに提供された値はForRenderingがfalseに設定されている場合は無視されます。
ForRenderingがfalseの場合、返されるパラメータメタデータは指定されたレポートに現在関連付けられているパラメータデータを表します。
クエリに基づくパラメータ値がいて、クエリベースのパラメータの有効値リストを返したい場合、 ForRendering を trueに設定してください。 さらに、クエリベースのパラメータについては、クエリパラメータを返すために必要なすべての認証情報を入力する必要があります。
パラメータ検証に GetReportParameters 法を使用する場合、 Values パラメータが必要です。
与えられたレポートのパラメータが存在しない場合は、空の ReportParameter 配列が返されます。