SPWeb.GetListItem Method

Article
07/24/2014

Gets the list item that is associated with the specified server-relative URL.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Function GetListItem ( _
    strUrl As String _
) As SPListItem
'Usage
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPListItem

returnValue = instance.GetListItem(strUrl)

public SPListItem GetListItem(
    string strUrl
)

Parameters

strUrl
Type: System.String

The server-relative URL of the list item, such as "/sites/sitecollection/Shared Documents/MyDocument.docx", or an absolute URL, such as https://server/sites/sitecollection/Shared Documents/MyDocument.docx.

Return Value

Type: Microsoft.SharePoint.SPListItem
The list item associated with the specified server-relative URL.

Exceptions

Exception	Condition
ArgumentNullException	strUrl is null .
DirectoryNotFoundException	The URL does not specify a valid path.
FileNotFoundException	The URL does not point to a valid list item.

Remarks

This method returns null if the list item cannot be found.

Examples

The following example is a console application that retrieves a list item from a document library and then prints the name of the associated file to the console.

Note that the example assumes the existence of a site collection with an absolute URL of https://localhost/sites/sitecollection and that this site collection has a website named 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("subsite")

            ' Build a server-relative Url for a list item.
            Dim itemUrl As String = web.RootFolder.ServerRelativeUrl
            itemUrl += "_catalogs/masterpage/default.master"

            ' Get the list item.
            Dim item As SPListItem = web.GetListItem(itemUrl)

            ' Print the file name.
            Console.WriteLine(item.File.Name)

         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("subsite"))
            {
               // Build a server-relative Url for a list item.
               string itemUrl = web.RootFolder.ServerRelativeUrl;
               itemUrl += "_catalogs/masterpage/default.master";

               // Get the list item.
               SPListItem item = web.GetListItem(itemUrl);

               // Print the file name.
               Console.WriteLine(item.File.Name);
            }
         }
         Console.ReadLine();
      }
   }
}

Share via