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 propiedades de parámetros para un elemento especificado. Este método también puede usarse para validar valores de parámetros frente a 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
La URL totalmente cualificada del elemento incluyendo el nombre del archivo y, en modo SharePoint, la extensión.
- HistoryID
- String
El ID de la instantánea del historial del artículo. Establece el ForRendering parámetro en un valor de true para recuperar las propiedades de los parámetros de una instantánea del historial de un ítem. Establece el valor en null (Nothing en Visual Basic) si estás recuperando parámetros para un elemento que no es una instantánea del historial del ítem.
- ForRendering
- Boolean
Una expresión que indica cómo se deben usar los valores de Boolean los parámetros. Si se establece en un valor de true, las propiedades del parámetro que se devuelven se basan en los datos del parámetro que se usaron durante la ejecución del elemento.
- Values
- ParameterValue[]
Los valores de los parámetros (ParameterValue objetos) que pueden validarse en relación con los parámetros de un elemento gestionado por el servidor de informes.
- Credentials
- DataSourceCredentials[]
Las credenciales de la fuente de datos (DataSourceCredentials objetos) que pueden usarse para validar los parámetros de consulta.
Devoluciones
Un array de ItemParameter objetos que lista los parámetros del elemento.
- Atributos
Ejemplos
Para compilar este ejemplo de código, debes consultar el WSDL de Reporting Services e importar ciertos espacios de nombres. Para más información, consulte Ejemplos de Compilación y Ejecución de Código. El siguiente ejemplo de código utiliza el GetItemParameters método para obtener una lista de metadatos de parámetros para un informe y luego 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
La siguiente tabla muestra la información sobre cabeceras y permisos sobre esta operación.
| Uso de la cabecera SOAP | (En) TrustedUserHeaderValue (Fuera) ServerInfoHeaderValue |
| Permisos requeridos en modo nativo | ReadProperties |
| Permisos requeridos en el modo SharePoint | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
Si la configuración de ejecución del elemento es Snapshot, los metadatos del parámetro que se devuelven son los datos que se usaron cuando se creó la instantánea del historial del ítem. Si la configuración de ejecución del elemento es Live, los metadatos de parámetros devueltos representan los datos de parámetros asociados al elemento especificado.
Si proporcionas un valor para el HistoryID parámetro y lo configuras ForRendering ,true los metadatos del parámetro devueltos representan los datos de parámetros que se usaron cuando se creó la instantánea del historial de los elementos. El valor proporcionado para HistoryID se ignora si ForRendering se establece en false. Si ForRendering es false, los metadatos de parámetros devueltos representan los datos de parámetros que actualmente están asociados al elemento especificado.
Si algún valor de parámetros se basa en una consulta y te interesa devolver la lista de valores válidos de los parámetros de consulta, fija ForRendering en true. Además, para parámetros basados en consultas, debes introducir toda la información de credenciales necesaria para devolver los parámetros de consulta.
Al utilizar el GetItemParameters método para validar parámetros, se requiere el Values parámetro.
Si no existen parámetros para el elemento dado, se devuelve un array vacío ItemParameter .