ReportingService2005.GetProperties(String, Property[]) Method

Definition

Namespace:

ReportService2005

Assembly:

ReportService2005.dll

Returns the value of one or more properties of an item in the report server database.

public:
 cli::array <ReportService2005::Property ^> ^ GetProperties(System::String ^ Item, cli::array <ReportService2005::Property ^> ^ Properties);

public ReportService2005.Property[] GetProperties (string Item, ReportService2005.Property[] Properties);

member this.GetProperties : string * ReportService2005.Property[] -> ReportService2005.Property[]

Public Function GetProperties (Item As String, Properties As Property()) As Property()

Parameters

Item

String

The full path name or the ID of the item.

Properties

Property[]

An array of Property objects that contains the properties for which you want to retrieve values.

Returns

Property[]

An array of Property objects that represents the properties of the specified item.

Examples

To compile this code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see Compiling and Running Code Examples. The following code example uses the GetProperties method to retrieve the description associated with the Company Sales report:

Imports System  
Imports System.Web.Services.Protocols  

Class Sample  
   Public Shared Sub Main()  
      Dim rs As New ReportingService2005()  
      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("/SampleReports/Company Sales", 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 'Main  
End Class 'Sample  

using System;  
using System.Web.Services.Protocols;  

class Sample  
{  
   public static void Main()  
   {  
      ReportingService2005 rs = new ReportingService2005();  
      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("/SampleReports/Company Sales", 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() );  
      }  
   }  
}  

Remarks

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

SOAP Headers	(In) ItemNamespaceHeaderValue (Out) ServerInfoHeaderValue
Required Permissions	Depends on the item type: - Folder: ReadProperties - Report: ReadProperties - Resource: ReadProperties - DataSource: ReadProperties - Model: ReadProperties

The default value that must be passed for this argument is the full path name. To supply an ID, you must set the ItemNamespaceHeader SOAP header. For more information, see Setting the Item Namespace for the GetProperties Method.

Use the GetProperties method to retrieve the complete set of user-defined and reserved properties. To retrieve the standard subset of reserved properties, use the ListChildren method. For a list of the reserved properties of items in the report server database, see Report Server Item Properties.

If the Properties parameter is null (Nothing in Visual Basic), all properties for the specified item are returned. These include all user-defined and built-in properties that are specific to the item.

You can pass the full path name of the item for the Item parameter or you can pass the ID of the item. For more information about using SOAP headers to accomplish this, see Using Reporting Services SOAP Headers.