ReportingService2005.ListChildren Method (ReportService2005)

ListChildren Method

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

ReportingService2005..::.ListChildren Method

Gets a list of children of a specified folder.

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

Syntax

Visual Basic (Declaration)

Public Function ListChildren ( _
	Item As String, _
	Recursive As Boolean _
) As CatalogItem()

Visual Basic (Usage)

Dim instance As ReportingService2005
Dim Item As String
Dim Recursive As Boolean
Dim returnValue As CatalogItem()

returnValue = instance.ListChildren(Item, _
	Recursive)

public CatalogItem[] ListChildren(
	string Item,
	bool Recursive
)

Visual C++

public:
array<CatalogItem^>^ ListChildren(
	String^ Item, 
	bool Recursive
)

member ListChildren : 
        Item:string * 
        Recursive:bool -> CatalogItem[]

JScript

public function ListChildren(
	Item : String, 
	Recursive : boolean
) : CatalogItem[]

Parameters

Item: Type: System..::.String
The full path name of the parent folder.

Recursive: Type: System..::.Boolean
A Boolean expression that indicates whether to return the entire tree of child items below the specified item. The default value is false.

Return Value

Type: array<ReportService2005..::.CatalogItem>[]()[]
An array of CatalogItem objects. If no children exist, this method returns an empty CatalogItem object.

Remarks

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

SOAP Headers	(Out) ServerInfoHeaderValue
Required Permissions	ReadProperties on Item

The ListChildren method returns only child items that the user has permission to view. The items that are returned may not represent a complete list of child items of the specified parent item.

If the ListChildren method is called on the root of the report server database with My Reports enabled, the method returns an array of CatalogItem objects containing properties for the folder My Reports. If the user is anonymous and My Reports is enabled, the properties for My Reports are not returned when ListChildren is called on the root.

The ListChildren method can return the VirtualPath property of items in the report server database that support virtual paths. The virtual path is the path under which a user expects to see the item. For example, a report called "Report1" located in the user's personal My Reports folder has a virtual path equal to "/My Reports". The actual path of the item is /Users/Username/My Reports.

The majority of the properties this method returns are read-only. For more information about item properties in Reporting Services, see Report Server Item Properties.

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 uses the ListChildren method to read the contents of the root of the report server directory tree, and then stores the first item and its properties as an XML document:

Visual Basic

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

Class Sample
   Public Shared Sub Main()
      Dim rs As New ReportingService2005()
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials

      Dim items As CatalogItem() = Nothing

      ' Retrieve a list of all items from the report server database. 
      Try
         items = rs.ListChildren("/", True)

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

      ' Serialize the contents as an XML document and write the contents to a file.
      Try
         Dim fs As New FileStream("CatalogItems.xml", FileMode.Create)
         Dim writer As New XmlTextWriter(fs, Encoding.Unicode)

         Dim serializer As New XmlSerializer(GetType(CatalogItem()))
         serializer.Serialize(writer, items)

         Console.WriteLine("Server contents successfully written to a file.")

      Catch e As Exception
         Console.WriteLine(e.Message)
      End Try
   End Sub 'Main
End Class 'Sample

using System;
using System.IO;
using System.Text;
using System.Web.Services.Protocols;
using System.Xml;
using System.Xml.Serialization;

class Sample
{
   public static void Main()
   {
      ReportingService2005 rs = new ReportingService2005();
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;

      CatalogItem[] items = null;

      // Retrieve a list of all items from the report server database. 
      try
      {
         items = rs.ListChildren("/", true);
      }

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

      // Serialize the contents as an XML document and write the contents to a file.
      try
      {
         FileStream fs = new FileStream("CatalogItems.xml", FileMode.Create);
         XmlTextWriter writer = new XmlTextWriter(fs, Encoding.Unicode); 

         XmlSerializer serializer = new XmlSerializer(typeof(CatalogItem[]));
         serializer.Serialize(writer, items);

         Console.WriteLine("Server contents successfully written to a file.");
      }

      catch (Exception e)
      {
         Console.WriteLine(e.Message);
      }
   }
}

Reference

ReportingService2005 Class

ReportService2005 Namespace