Export (0) Print
Expand All
Expand Minimize

ReportingService2010.ListChildren Method

Gets a list of children of a specified folder.

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

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

returnValue = instance.ListChildren(ItemPath, _
	Recursive)

Parameters

ItemPath
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.Note   Setting this parameter to true in SharePoint mode can significantly reduce the performance of your application.

Return Value

Type: ReportService2010.CatalogItem()
An array of CatalogItem objects. If no children exist, this method returns an empty array.

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

ReadProperties on Item

SharePoint Mode Required Permissions

ViewListItems

This 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 this 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 this method is called on the root.

This 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.

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:

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 ReportingService2010()
      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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft