SPSite Class

The SPSite class represents a collection of sites on a virtual server, including a top-level site and all its subsites. Each SPSite object, or site collection, is represented within an SPSiteCollection object that consists of the collection of all site collections on the virtual server.

System.Object

   Microsoft.SharePoint.SPSite

Public Constructors

The following table shows the public constructors of the SPSite class and a brief description of each.

Public Fields

The following table shows the public fields of the SPSite class and a brief description of each.

Public Methods

The following table shows the public methods of the SPSite class and a brief description of each.

Public Properties

The following table shows the public properties of the SPSite class, the data type of each property, and a brief description of each.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.

Remarks

To instantiate an SPSite object for a specific site collection on an ASP.NET page, or for a specific site collection within a console application, use the SPSite constructor as follows:

SPSite mySite = new SPSite("Absolute_URL");

Within an ASP.NET application, use the GetContextSite method of the SPControl class to return an SPSite object that represents the current site, as follows:

SPSite mySite = SPControl.GetContextSite(Context);

Use the Sites property of the SPVirtualServer class to return an SPSiteCollection object that represents the collection of site collections on a virtual server. Use an indexer to return a single site collection from the collection. For example, if the collection is assigned to a variable named mySites, use mySites[index] in C#, or mySites(index) in Visual Basic .NET, where index is either the index number of the site in the collection or the display name of the site.

If you create your own SPSite object, you can use the Dispose method or the Close method to close the object. However, if you have a reference to a shared resource, such as when the object is provided by the GetContextSite method in a Web Part, do not use either method to close the object. In scenarios where you have a reference to a shared resource, instead let Windows SharePoint Services or your portal application manage the object. Using either method on a shared resource causes an access violation error to occur.

Requirements

Namespace: Microsoft.SharePoint

Platforms: Microsoft Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security