SPWeb.GetList method

發行項
05/05/2015

取得與指定的伺服器相對 URL 相關聯的清單。

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'宣告
Public Function GetList ( _
    strUrl As String _
) As SPList
'用途
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPList

returnValue = instance.GetList(strUrl)

public SPList GetList(
    string strUrl
)

參數

strUrl
Type: System.String

一份清單，例如/sites/sitecollection/subsite/Lists/Announcements的根資料夾伺服器相對 URL。

傳回值

Type: Microsoft.SharePoint.SPList
在指定的伺服器相對 URL 清單。

Exceptions

Exception	Condition
FileNotFoundException	URL 未指定有效的路徑至網站，或是清單不存在於此網站。
ArgumentException	strUrl參數是 null 的參考。

備註

當您呼叫這個方法時使用無效的 URL，會擲回例外狀況和AllowUnsafeUpdates屬性的值設定為false。

使用GetListFromWebPartPageUrl方法來傳回第一個網頁組件，在 [網頁組件頁面相關聯的清單。

Examples

下列範例是示範如何取得SPList物件，表示在網站上的 [宣告] 清單的主控台應用程式。

請注意此範例假設使用絕對 URL 的https://localhost/sites/sitecollection網站集合的存在，而且此網站集合具有名為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();
      }
   }
}