ReportingService2010.GetItemParameters Método

Referência

Definição

Namespace:: ReportService2010

Assembly:: ReportService2010.dll

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âmetro para um item especificado. Este método também pode ser usado para validar valores de parâmetros em relação aos parâmetros para 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 a extensão no modo do SharePoint.

HistoryID: String

A ID do instantâneo de histórico de itens. Defina o ForRendering parâmetro como um valor de para recuperar propriedades de true parâmetro para um histórico de itens instantâneo. Defina o valor como null (Nothing no Visual Basic) se você estiver recuperando parâmetros de um item que não é um instantâneo de histórico de itens.

ForRendering: Boolean

Uma expressão Boolean que indica como os valores de parâmetros serão usados. Se o valor for definido como true, as propriedades de parâmetro retornadas terão como base os dados de parâmetro usados durante a execução do item.

Values: ParameterValue[]

Os valores de parâmetro (objetos ParameterValue) que podem ser validados em relação aos parâmetros de um item que é gerenciado pelo servidor de relatório.

Credentials: DataSourceCredentials[]

As credenciais de fonte de dados (objetos DataSourceCredentials) que podem ser usados para validar parâmetros de consulta.

Retornos

ItemParameter[]

Uma matriz de objetos ItemParameter que lista os parâmetros do item.

Atributos: SoapDocumentMethodAttribute SoapHeaderAttribute

Exemplos

Para compilar esse exemplo de código, você deve referenciar o WSDL Reporting Services e importar determinados namespaces. Para obter mais informações, consulte Compilando e executando exemplos de código. O exemplo de código a seguir usa o GetItemParameters método para recuperar uma lista de metadados de parâmetro para um relatório e 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 a seguir mostra o cabeçalho e as informações de permissão sobre esta operação.


Uso do cabeçalho SOAP	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Permissões necessárias do modo nativo	ReadProperties
Permissões necessárias do modo do SharePoint	<xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems>

Se a configuração de execução do item for Snapshot, os metadados de parâmetro retornados serão os dados que foram usados quando o histórico de itens instantâneo foi criado. Se a configuração de execução do item for Live, os metadados de parâmetro retornados representarão os dados de parâmetro associados ao item especificado.

Se você fornecer um valor para o HistoryID parâmetro e definir o valor do ForRendering parâmetro comotrue , os metadados de parâmetro retornados representarão os dados de parâmetro que foram usados quando o histórico de itens instantâneo foi criado. O valor fornecido para HistoryID será ignorado se ForRendering for definido falsecomo . Se ForRendering for false, os metadados de parâmetro retornados representarão os dados de parâmetro associados ao item especificado no momento.

Se os valores de parâmetros forem baseados em uma consulta e você estiver interessado em retornar a lista de valores válidos dos parâmetros baseados em consulta, defina ForRendering como true. Além disso, para parâmetros baseados em consulta, você deve passar todas as informações de credencial necessárias para retornar os parâmetros de consulta.

Ao usar o GetItemParameters método para validar parâmetros, o Values parâmetro é necessário.

Se os parâmetros não existirem para o item fornecido, uma matriz vazia ItemParameter será retornada.

Aplica-se a

Compartilhar via