ReportingService2010.GetItemParameters Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Retorna propriedades de parâmetros para um item especificado. Esse método também pode ser usado para validar valores de parâmetros em relação a parâmetros de um item especificado.
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()
Parâmetros
- ItemPath
- String
A URL totalmente qualificada do item, incluindo o nome do arquivo e, no modo SharePoint, a extensão.
- HistoryID
- String
O ID do snapshot do histórico do item. Defina o ForRendering parâmetro para um valor de true para recuperar propriedades de parâmetros para um instantâneo de histórico de itens. Defina o valor para null (Nothing no Visual Basic) se você estiver recuperando parâmetros para um item que não seja um snapshot do histórico do item.
- ForRendering
- Boolean
Uma Boolean expressão que indica como os valores dos parâmetros devem ser usados. Se definido para um valor de true, as propriedades dos parâmetros retornadas são baseadas nos dados do parâmetro usados durante a execução do item.
- Values
- ParameterValue[]
Os valores dos parâmetros (ParameterValue objetos) que podem ser validados em relação aos parâmetros de um item gerenciado pelo servidor de relatórios.
- Credentials
- DataSourceCredentials[]
As credenciais da fonte de dados (DataSourceCredentials objetos) que podem ser usadas para validar parâmetros de consulta.
Retornos
Um array de ItemParameter objetos que lista os parâmetros do item.
- Atributos
Exemplos
Para compilar esse exemplo de código, você deve consultar o Reporting Services WSDL e importar certos namespaces. Para mais informações, veja Exemplos de Código Compilando e Executando. O exemplo de código a seguir usa o GetItemParameters método para recuperar uma lista de metadados de parâmetros para um relatório e então exibe o nome de cada parâmetro:
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());
}
}
}
Comentários
A tabela abaixo mostra informações sobre cabeçalhos e permissões sobre esta operação.
| Uso do Cabeçalho SOAP | (Em) TrustedUserHeaderValue (Fora) ServerInfoHeaderValue |
| Modo Nativo Necessário Permissões | ReadProperties |
| Permissões Necessárias no Modo SharePoint | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
Se a configuração de execução do item for Snapshot, os metadados do parâmetro retornados são os dados usados quando o snapshot do histórico do item foi criado. Se a configuração de execução do item for Live, os metadados do parâmetro retornados representam os dados do parâmetro associados ao item especificado.
Se você fornecer um valor para o HistoryID parâmetro e definir o ForRendering valor do parâmetro para,true os metadados do parâmetro retornados representam os dados do parâmetro usados quando o snapshot do histórico do item foi criado. O valor fornecido para HistoryID é ignorado se ForRendering for definido como false. Se ForRendering for false, os metadados do parâmetro retornados representam os dados do parâmetro atualmente associados ao item especificado.
Se algum valor de parâmetro for baseado em uma consulta e você estiver interessado em retornar a lista de valores válidos dos parâmetros baseados em consulta, defina ForRendering para true. Além disso, para parâmetros baseados em consulta, você deve passar todas as informações de credenciais necessárias para devolver os parâmetros da consulta.
Ao usar o GetItemParameters método para validar parâmetros, o Values parâmetro é necessário.
Se não existirem parâmetros para o item dado, um array vazio ItemParameter é retornado.