Lists.GetList Method

Returns a schema for the specified list.

Namespace:  [Lists Web service]
Web service reference: http://Site/_vti_bin/Lists.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetList", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetList ( _
    listName As String _
) As XmlNode
'Usage
Dim instance As Lists
Dim listName As String
Dim returnValue As XmlNode

returnValue = instance.GetList(listName)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetList", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode GetList(
    string listName
)

Parameters

• listName
  Type: System.String

  A string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains "UserInfo".

Return Value

Type: System.Xml.XmlNode
A fragment in Collaborative Application Markup Language (CAML) in the following form that contains the list schema and that can be assigned to a System.Xml.XmlNode object.

<List DocTemplateUrl="" DefaultViewUrl="/Site_Name/Lists/List_Name/AllItems.aspx" 
   ID="{42FC00F1-F7EA-4ECE-9D4C-F47A95A806B2}" Title="List_Name" Description="Description" 
   ImageUrl="/_layouts/images/itgen.gif" Name="{42FC00F1-F7EA-4ECE-9D4C-F47A95A806B2}" 
   BaseType="0" ServerTemplate="100" Created="20030616 18:37:44" Modified="20030618 18:26:57" 
   LastDeleted="20030616 18:37:44" Version="2" Direction="none" ThumbnailSize="" WebImageWidth="" 
   WebImageHeight="" Flags="4096" ItemCount="5" AnonymousPermMask="" 
   RootFolder="/Site_Name/Lists/List_Name" 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" 
   xmlns="https://schemas.microsoft.com/sharepoint/soap/">
   <Fields>
      <Field ColName="tp_ID" ReadOnly="TRUE" Type="Counter" Name="ID" PrimaryKey="TRUE" 
         DisplayName="ID" FromBaseType="TRUE" />
      <Field Type="Text" Name="Title" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" 
         ColName="nvarchar1" />
         ...
   <Fields>
   <RegionalSettings>
      <Language>1033<Language>
      <Locale>1025<Locale>
      <CalendarType>6<CalendarType>
      <AdvanceHijri>-1</AdvanceHijri>
      <TimeZone>1</TimeZone>
      <Time24>1</Time24>
      <SortOrder>1033<SortOrder>
      <Presence Enabled=”True” />
    </RegionalSettings>
</List>

Examples

The following code example displays the schema for a specified list.

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.GetList("List_Name")

MessageBox.Show(ndLists.OuterXml)

Web_Reference_Folder.Lists listService = new Web_Reference_Folder.Lists();
listService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlNode ndLists = listService.GetList("List_Name");

MessageBox.Show(ndLists.OuterXml);

See Also

Reference

Lists Class

Lists Members

Lists Web Service