ReportingService2005.GetReportParameters Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает свойства параметра указанного отчета. Метод GetReportParameters(String, String, Boolean, ParameterValue[], DataSourceCredentials[]) также можно использовать для проверки значений параметров по параметрам для указанного отчета.
public:
cli::array <ReportService2005::ReportParameter ^> ^ GetReportParameters(System::String ^ Report, System::String ^ HistoryID, bool ForRendering, cli::array <ReportService2005::ParameterValue ^> ^ Values, cli::array <ReportService2005::DataSourceCredentials ^> ^ Credentials);
public ReportService2005.ReportParameter[] GetReportParameters (string Report, string HistoryID, bool ForRendering, ReportService2005.ParameterValue[] Values, ReportService2005.DataSourceCredentials[] Credentials);
member this.GetReportParameters : string * string * bool * ReportService2005.ParameterValue[] * ReportService2005.DataSourceCredentials[] -> ReportService2005.ReportParameter[]
Public Function GetReportParameters (Report As String, HistoryID As String, ForRendering As Boolean, Values As ParameterValue(), Credentials As DataSourceCredentials()) As ReportParameter()
Параметры
- Report
- String
Полный путь к отчету.
- HistoryID
- String
Идентификатор моментального снимка журнала отчета. Присвойте ForRendering
параметру значение , true
чтобы получить свойства параметра для журнала отчета snapshot. Чтобы получить параметры для отчета, который не является моментальным снимком журнала отчета, задайте значение null
(Nothing
в Visual Basic).
- ForRendering
- Boolean
Выражение типа Boolean
, которое показывает, как должны использоваться значения параметров. Если параметр имеет значение true
, то его возвращаемые свойства зависят от данных параметра, которые использовались во время выполнения отчета.
- Values
- ParameterValue[]
Значения параметров (объекты ParameterValue), которые могут проверяться по параметрам отчета, управляемого сервером отчетов.
- Credentials
- DataSourceCredentials[]
Учетные данные источника данных (объекты DataSourceCredentials), которые можно использовать для проверки параметров запроса.
Возвращаемое значение
Массив объектов ReportParameter, содержащий список параметров для отчета.
Примеры
Чтобы скомпилировать этот пример кода, необходимо сослаться на Reporting Services WSDL и импортировать определенные пространства имен. Дополнительные сведения см. в разделе Примеры компиляции и выполнения кода. В следующем примере кода метод используется GetReportParameters для получения списка метаданных параметров для отчета, а затем отображается имя каждого параметра:
Imports System
Imports System.Web.Services.Protocols
Class Sample
Public Shared Sub Main()
Dim rs As New ReportingService2005()
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 ReportParameter() = Nothing
Try
parameters = rs.GetReportParameters(report, historyID, forRendering, 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 'Main
End Class 'Sample
using System;
using System.Web.Services.Protocols;
class Sample
{
public static void Main()
{
ReportingService2005 rs = new ReportingService2005();
rs.Credentials = System.Net.CredentialCache.DefaultCredentials;
string report = "/SampleReports/Employee Sales Summary";
bool forRendering = false;
string historyID = null;
ParameterValue[] values = null;
DataSourceCredentials[] credentials = null;
ReportParameter[] parameters = null;
try
{
parameters = rs.GetReportParameters(report, historyID, forRendering, 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());
}
}
}
Комментарии
В следующей таблице показаны сведения о заголовках и разрешениях для этой операции.
Заголовки SOAP | (Out) ServerInfoHeaderValue |
Необходимые разрешения | ReadProperties |
Если параметр выполнения для отчета имеет значение Snapshot
, возвращаемые метаданные параметра — это данные, которые использовались при создании журнала отчета snapshot. Если параметр выполнения для отчета имеет значение Live
, возвращаемые метаданные параметра представляют данные параметров, связанные с указанным отчетом.
Если указать значение параметра HistoryID
и задать ForRendering
для параметра значение true
, возвращаемые метаданные параметра представляют данные параметров, которые использовались при создании журнала отчета snapshot. Значение, указанное для HistoryID
, игнорируется, если ForRendering
для задано значение false
. Если ForRendering
имеет значение false
, возвращаемые метаданные параметра представляют данные параметров, которые в настоящее время связаны с указанным отчетом.
Если какие-либо значения параметров основаны на запросе и вы хотите вернуть список допустимых значений параметров на основе запроса, задайте для true
значение ForRendering
. Кроме того, для параметров на основе запроса необходимо передать все учетные данные, необходимые для возврата параметров запроса.
При использовании GetReportParameters метода для проверки параметров Values
параметр является обязательным.
Если параметры отчета не существуют для данного отчета, возвращается пустой ReportParameter массив.