ReportingService2005.GetProperties Method
Returns the value of one or more properties of an item in the report server database.
Namespace: ReportService2005
Assembly: ReportService2005 (in ReportService2005.dll)
Syntax
'Declaration
Public Function GetProperties ( _
Item As String, _
Properties As Property() _
) As Property()
'Usage
Dim instance As ReportingService2005
Dim Item As String
Dim Properties As Property()
Dim returnValue As Property()
returnValue = instance.GetProperties(Item, _
Properties)
public Property[] GetProperties(
string Item,
Property[] Properties
)
public:
array<Property^>^ GetProperties(
String^ Item,
array<Property^>^ Properties
)
member GetProperties :
Item:string *
Properties:Property[] -> Property[]
public function GetProperties(
Item : String,
Properties : Property[]
) : Property[]
Parameters
- Item
Type: System.String
The full path name or the ID of the item.
- Properties
Type: array<ReportService2005.Property[]
An array of Property objects that contains the properties for which you want to retrieve values.
Return Value
Type: array<ReportService2005.Property[]
An array of Property objects that represents the properties of the specified item.
Remarks
The table below shows header and permissions information on this operation.
SOAP Headers |
(Out) ServerInfoHeaderValue |
Required Permissions |
Depends on the item type:
|
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 nulla null reference (Nothing in Visual Basic) (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.
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() );
}
}
}