del método SPWeb.GetList

Artículo
05/13/2015

Obtiene la lista que está asociada con la dirección URL relativa al servidor especificada.

Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Public Function GetList ( _
    strUrl As String _
) As SPList
'Uso
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPList

returnValue = instance.GetList(strUrl)

public SPList GetList(
    string strUrl
)

Parámetros

strUrl
Tipo: System.String

Dirección URL relativa al servidor a la carpeta raíz de una lista, como /sites/sitecollection/subsite/Lists/Announcements.

Valor devuelto

Tipo: Microsoft.SharePoint.SPList
La lista en la dirección URL relativa al servidor especificada.

Excepciones

Excepción	Condición
FileNotFoundException	La dirección URL no especifique una ruta válida para el sitio Web o la lista no existe en el sitio Web.
ArgumentException	El parámetro strUrl es una referencia de nulo .

Comentarios

Cuando se llama a este método con una dirección URL no válida, se produce una excepción y se establece el valor de la propiedad AllowUnsafeUpdates en false.

Utilice el método GetListFromWebPartPageUrl para devolver la lista que está asociada con el primer elemento Web en una página de elementos Web.

Ejemplos

En el siguiente ejemplo es una aplicación de consola que muestra cómo obtener un objeto SPList que representa la lista de anuncios en un sitio Web.

Tenga en cuenta que el ejemplo supone la existencia de una colección de sitios con una dirección URL absoluta de https://localhost/sites/sitecollection y que esta colección de sitios tiene un sitio Web denominado 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();
      }
   }
}