ReportingService2010.GetProperties Method

Returns the value of one or more properties of an item in a report server database or SharePoint library. This method applies to all item types.

Namespace:  ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

Syntax

'Declaration
<SoapHeaderAttribute("ItemNamespaceHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetProperties", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Function GetProperties ( _
    ItemPath As String, _
    Properties As Property() _
) As Property()
'Usage
Dim instance As ReportingService2010 
Dim ItemPath As String 
Dim Properties As Property()
Dim returnValue As Property()

returnValue = instance.GetProperties(ItemPath, _
    Properties)

[SoapHeaderAttribute("ItemNamespaceHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetProperties", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public Property[] GetProperties(
    string ItemPath,
    Property[] Properties
)

[SoapHeaderAttribute(L"ItemNamespaceHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetProperties", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
array<Property^>^ GetProperties(
    String^ ItemPath, 
    array<Property^>^ Properties
)

[<SoapHeaderAttribute("ItemNamespaceHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetProperties", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member GetProperties : 
        ItemPath:string * 
        Properties:Property[] -> Property[] 

public function GetProperties(
    ItemPath : String, 
    Properties : Property[]
) : Property[]

Parameters

• ItemPath
  Type: System.String
  The fully qualified URL of the item including the file name and extension, or the ID of the item.

• Properties
  Type: array<ReportService2010.Property[]
  An array of Property objects that contains the properties for which you want to retrieve values.

Return Value

Type: array<ReportService2010.Property[]
An array of Property objects that represent the properties of the specified item.

Remarks

The table below shows header and permissions information on this operation.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
{
    static void Main(string[] args)
    {
        ReportingService2010 rs = new ReportingService2010();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2010.asmx";
        rs.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        // Create the property to retrieve.
        Property retrieveProp = new Property();
        retrieveProp.Name = "Description";
        Property[] props = new Property[1];
        props[0] = retrieveProp;

        try
        {
            Property[] properties = 
                rs.GetProperties("http://<Server Name>/Docs" +
                    "/Documents/AdventureWorks Sample Reports" +
                    "/Sales Order Detail.rdl", props);

            foreach (Property prop in properties)
            {
                // Writes the description to the console.
                Console.WriteLine(prop.Value);
            }
        }
        catch (SoapException e)
        {
            Console.WriteLine(e.Detail.InnerXml.ToString());
        }
    }
}

Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols

Class Sample

    Public Shared Sub Main()

        Dim rs As New ReportingService2010()
        rs.Url = "http://<Server Name>" + _
            "/_vti_bin/ReportServer/ReportService2010.asmx"
        rs.Credentials = _
            System.Net.CredentialCache.DefaultCredentials

        ' Create the property to retrieve.
        Dim retrieveProp As New [Property]()
        retrieveProp.Name = "Description"
        Dim props(0) As [Property]
        props(0) = retrieveProp

        Try
            Dim properties As [Property]() = _
                rs.GetProperties("http://<Server Name>/Docs" + _
                    "/Documents/AdventureWorks Sample Reports" + _
                    "/Sales Order Detail.rdl", props)

            Dim prop As [Property]
            For Each prop In properties
                ' Writes the description to the console.
                Console.WriteLine(prop.Value)
            Next prop

        Catch e As SoapException
            Console.WriteLine(e.Detail.InnerXml.ToString())
        End Try

    End Sub

End Class

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace