ReportingService2005.SetProperties(String, Property[]) Method

Reference

Definition

Namespace:: ReportService2005

Assembly:: ReportService2005.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets one or more properties of a specified item.

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

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

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

Public Sub SetProperties (Item As String, Properties As Property())

Parameters

Item: String

The full path name of the item.

Properties: Property[]

An array of Property objects that defines the properties and values to set for the item.

Examples

To compile the following 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 sets a new description for 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  

      Dim props(0) As [Property]  
      Dim setProp As New [Property]()  
      setProp.Name = "Description"  
      setProp.Value = "Sales by quarter and product category."  
      props(0) = setProp  

      Dim itemPath As String = "/SampleReports/Company Sales"  

      Try  
         rs.SetProperties(itemPath, props)  
         Console.WriteLine("New description set on item {0}.", itemPath)  

      Catch ex As SoapException  
         Console.WriteLine(ex.Detail.OuterXml)  
      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;  

      Property[] props = new Property[1];  
      Property setProp = new Property();  
      setProp.Name = "Description";  
      setProp.Value = "Sales by quarter and product category.";  
      props[0] = setProp;  

      string itemPath = "/SampleReports/Company Sales";   

      try  
      {  
         rs.SetProperties(itemPath, props);  
         Console.WriteLine("New description set on item {0}.", itemPath);  
      }  

      catch (SoapException ex)  
      {  
         Console.WriteLine(ex.Detail.OuterXml);  
      }  
   }  
}

Remarks

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


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

You can create new user-defined properties for an item by passing a Property object as a method argument. To remove a property from an item, set the property to an empty value. You cannot remove reserved properties. For a list of reserved item properties, see Report Server Item Properties.

If a specified property does not exist when the SetProperties method is called, the property is created and set to the value you supply. If the property already exists, its value is overwritten. Setting an empty value for a property that does not exist has no effect on the item or its properties.

If an error occurs, no properties are set.

Applies to

Share via