ReportingService2010.GetItemParameters Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Devuelve las propiedades de parámetro para un elemento especificado. Este método también se puede utilizar para validar los valores de parámetro contra los parámetros para un elemento 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
Dirección URL completa del elemento, incluidos el nombre de archivo y la extensión, en modo de SharePoint.
- HistoryID
- String
Identificador de la instantánea del historial de elementos. Establezca el ForRendering
parámetro en un valor de para recuperar las propiedades de true
parámetro de una instantánea del historial de elementos. Establezca el valor en null
(Nothing
en Visual Basic) si va a recuperar los parámetros de un elemento que no es una instantánea del historial de elementos.
- ForRendering
- Boolean
Expresión Boolean
que indica cómo se van a usar los valores de los parámetros. Si está establecido en un valor true
, las propiedades del parámetro que se devuelven se basan en los datos de los parámetros que se utilizaron durante la ejecución del elemento.
- Values
- ParameterValue[]
Valores de los parámetros (objetosParameterValue ) que se pueden validar con los parámetros de un elemento que administra el servidor de informes.
- Credentials
- DataSourceCredentials[]
Credenciales del origen de datos (objetosDataSourceCredentials) que se pueden utilizar para validar los parámetros de la consulta.
Devoluciones
Matriz de objetos ItemParameter que enumeran los parámetros para el elemento.
- Atributos
Ejemplos
Para compilar este ejemplo de código, debe hacer referencia al Reporting Services WSDL e importar determinados espacios de nombres. Para obtener más información, vea Compilar y ejecutar ejemplos de código. En el ejemplo de código siguiente se usa el GetItemParameters método para recuperar una lista de metadatos de parámetros para un informe y, a continuación, se muestra el nombre 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());
}
}
}
Comentarios
En la siguiente tabla se muestra la información de encabezado y de permisos de esta operación.
Uso del encabezado SOAP | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
Permisos necesarios en modo nativo | ReadProperties |
Permisos necesarios en modo de SharePoint | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
Si la configuración de ejecución del elemento es Snapshot
, los metadatos de parámetro que se devuelven son los datos que se usaron cuando se creó la instantánea del historial de elementos. Si la configuración de ejecución del elemento es Live
, los metadatos de parámetro devueltos representan los datos de parámetro asociados al elemento especificado.
Si proporciona un valor para el HistoryID
parámetro y establece el valortrue
del ForRendering
parámetro en, los metadatos de parámetro devueltos representan los datos de parámetro que se usaron cuando se creó la instantánea del historial de elementos. El valor proporcionado para HistoryID
se omite si ForRendering
se establece en false
. Si ForRendering
es false
, los metadatos de parámetro devueltos representan los datos de parámetro que están asociados actualmente al elemento especificado.
Si los valores de parámetros se basan en una consulta y está interesado en devolver la lista de valores válidos de los parámetros basados en consultas, establezca en ForRendering
true
. Además, para los parámetros basados en consultas, debe pasar toda la información de credenciales necesaria para devolver los parámetros de consulta.
Cuando se usa el GetItemParameters método para validar parámetros, se requiere el Values
parámetro .
Si los parámetros no existen para el elemento especificado, se devuelve una matriz vacía ItemParameter .