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
Идентификатор моментального снимка журнала элемента. Присвойте ForRendering
параметру значение true
, чтобы получить свойства параметра для журнала элементов snapshot. Чтобы получить параметры для элемента, который не является моментальным снимком журнала элемента, задайте значение null
(Nothing
в Visual Basic).
- 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
, то возвращаемые метаданные параметра — это данные, которые использовались при создании журнала элементов snapshot. Если параметр выполнения для элемента имеет значение Live
, возвращаемые метаданные параметра представляют данные параметров, связанные с указанным элементом.
Если указать значение параметра HistoryID
и задать ForRendering
для параметра значениеtrue
, возвращаемые метаданные параметра представляют данные параметров, которые использовались при создании snapshot журнала элементов. Значение, предоставленное для HistoryID
, игнорируется, если ForRendering
задано значение false
. Если ForRendering
имеет значение false
, возвращаемые метаданные параметра представляют данные параметров, которые в настоящее время связаны с указанным элементом.
Если какие-либо значения параметров основаны на запросе и вы хотите вернуть список допустимых значений параметров на основе запроса, задайте значение ForRendering
true
. Кроме того, для параметров на основе запроса необходимо передать все учетные данные, необходимые для возврата параметров запроса.
При использовании GetItemParameters метода для проверки параметров Values
параметр является обязательным.
Если для заданного элемента не существует параметров, возвращается пустой ItemParameter массив.