Lists.GetListCollection Method

Returns the names and GUIDs for all lists in the site.

Web Service: ListsWeb Reference: http://<Site>/_vti_bin/Lists.asmx

Syntax

<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/GetListCollection", RequestNamespace:="http://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace:="http://schemas.microsoft.com/sharepoint/soap/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function GetListCollection As XmlNode

Dim instance As Lists
Dim returnValue As XmlNode

returnValue = instance.GetListCollection
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/GetListCollection", RequestNamespace="http://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace="http://schemas.microsoft.com/sharepoint/soap/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public XmlNode GetListCollection ()

Return Value

A fragment in Collaborative Application Markup Language (CAML) in the following form that contains the names and GUIDs for the lists, and that can be assigned to a System.Xml.XmlNode object.

<Lists xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <List DocTemplateUrl=
      "" DefaultViewUrl="/TestWeb1/Lists/Announcements/AllItems.aspx" 
      ID="{8A98E2E5-B377-4D0E-931B-3AC25BD09926}" Title="Announcements" 
      Description="Use the Announcements list to post messages on the 
         home page of your site." 
      ImageUrl="/_layouts/images/itann.gif" 
         Name="{8A98E2E5-B377-4D0E-931B-3AC25BD09926}" 
      BaseType="0" ServerTemplate="104" 
         Created="20030613 18:47:12" Modified="20030613 18:47:12" 
      LastDeleted="20030613 18:47:12" Version="0" Direction="none" 
         ThumbnailSize="" WebImageWidth="" 
      WebImageHeight="" Flags="4096" ItemCount="1" 
         AnonymousPermMask="" RootFolder="" ReadSecurity="1" 
      WriteSecurity="1" Author="1" 
         EventSinkAssembly="" EventSinkClass="" 
         EventSinkData="" EmailInsertsFolder="" 
      AllowDeletion="True" AllowMultiResponses="False" 
         EnableAttachments="True" EnableModeration="False" 
      EnableVersioning="False" Hidden="False" MultipleDataList="False" 
         Ordered="False" ShowUser="True" />
   <List DocTemplateUrl=
      "" DefaultViewUrl="/TestWeb1/Lists/Contacts/AllItems.aspx" 
      ID="{9FFE6155-DB75-4E0C-B18C-095326112151}" Title="Contacts" 
      Description="Use the Contacts list for information about people 
         that your team works with." 
      ImageUrl="/_layouts/images/itcontct.gif" 
         Name="{9FFE6155-DB75-4E0C-B18C-095326112151}" 
      BaseType="0" ServerTemplate="105" Created="20030613 18:47:14" 
         Modified="20030613 18:47:14" 
      LastDeleted="20030613 18:47:14" Version="0" Direction="none" 
         ThumbnailSize="" WebImageWidth="" 
      WebImageHeight="" Flags="4096" ItemCount="0" 
         AnonymousPermMask="" RootFolder="" ReadSecurity="1" 
      WriteSecurity="1" Author="1" 
         EventSinkAssembly="" EventSinkClass="" EventSinkData="" 
      EmailInsertsFolder="" AllowDeletion="True" 
         AllowMultiResponses="False" EnableAttachments="True" 
      EnableModeration="False" EnableVersioning="False" Hidden="False" 
         MultipleDataList="False" 
      Ordered="False" ShowUser="True" />
      ...
</Lists>

Example

The following code example displays information about each of the lists on the current site.

This example requires that a using (Visual C#) or Imports (Visual Basic) directive be included for the System.Xml namespace.

Dim listService As New Web_Reference_Folder.Lists()
listService.Credentials = System.Net.CredentialCache.DefaultCredentials

Dim ndLists As XmlNode = listService.GetListCollection()

MessageBox.Show(ndLists.OuterXml)
Web_Reference_Folder.Lists listService = new Web_Reference_Folder.Lists();
listService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlNode ndLists = listService.GetListCollection();

MessageBox.Show(ndLists.OuterXml);

See Also

Reference

Lists Class
Lists Members
Lists Web Service