SPWeb.GetList - Méthode

Article
05/12/2015

Obtient la liste correspondant est associée à l'URL relative de serveur spécifiée.

Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function GetList ( _
    strUrl As String _
) As SPList
'Utilisation
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPList

returnValue = instance.GetList(strUrl)

public SPList GetList(
    string strUrl
)

Paramètres

strUrl
Type : System.String

L'URL relative de serveur dans le dossier racine de la liste, par exemple /sites/sitecollection/subsite/Lists/Announcements.

Valeur renvoyée

Type : Microsoft.SharePoint.SPList
La liste à l'URL relative de serveur spécifiée.

Exceptions

Exception	Condition
FileNotFoundException	L'URL ne spécifie pas un chemin valide vers le site Web, soit la liste n'existe pas dans le site Web.
ArgumentException	Le paramètre strUrl est une référence à null .

Remarques

Lorsque vous appelez cette méthode à l'aide d'une URL non valide, une exception est levée et la valeur de la propriété AllowUnsafeUpdates est définie sur false.

Utilisez la méthode GetListFromWebPartPageUrl pour renvoyer la liste qui est associée avec le premier composant WebPart dans une page de composant WebPart.

Exemples

L'exemple suivant est une application de console qui montre comment obtenir un objet SPList qui représente la liste d'annonces sur un site Web.

Notez que l'exemple suppose l'existence d'une collection de sites avec une URL absolue de https://localhost/sites/sitecollection et que cette collection de sites possède un site Web nommé subsite.

Imports System
Imports Microsoft.SharePoint

Module ConsoleApp
   Sub Main()
      Using site As SPSite = New SPSite("https://localhost/sites/sitecollection")
         Using web As SPWeb = site.OpenWeb("sitecollection/subsite")

            Dim listUrl As String = "/sites/sitecollection/subsite/Lists/Announcements"
            Dim list As SPList = web.GetList(listUrl)
            Console.WriteLine("List URL: {0}", list.RootFolder.ServerRelativeUrl)

         End Using
      End Using
      Console.ReadLine()
   End Sub
End Module

using System;
using Microsoft.SharePoint;

namespace Test
{
   class ConsoleApp
   {
      static void Main(string[] args)
      {
         using (SPSite site = new SPSite("https://localhost/sites/sitecollection"))
         {
            using (SPWeb web = site.OpenWeb("sitecollection/subsite"))
            {
               string listUrl = "/sites/sitecollection/subsite/Lists/Announcements";
               SPList list = web.GetList(listUrl);
               Console.WriteLine("List URL: {0}", list.RootFolder.ServerRelativeUrl);
            }
         }
         Console.ReadLine();
      }
   }
}