SPSite constructor (String)

Initializes a new instance of the SPSite class based on the specified URL.

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

Syntax

'Declaration
Public Sub New ( _
    requestUrl As String _
)
'Usage
Dim requestUrl As String

Dim instance As New SPSite(requestUrl)
public SPSite(
    string requestUrl
)

Parameters

  • requestUrl
    Type: System.String

    The absolute URL for the site collection.

Exceptions

Exception Condition
FileNotFoundException

The site collection could not be found.

Remarks

The URL that is passed to the SPSite constructor does not need to match a site collection URL exactly. See examples below.

Warning

This constructor is allowed in sandboxed solutions. in that case, the value of the requestUrl parameter must resolve to the parent site collection in which the sandboxed solution is deployed. If the value of the requestUrl parameter resolves to the URL of any other site collection, the constructor throws an exception because a sandboxed solution is not allowed to access any SharePoint objects outside its hosting site collection.

Examples

The following code example returns the site collection that is located at http://Server_Name/sites/Site_Name even though the URL that is passed to the constructor does not match the site collection URL.

Using oSiteCollection As New SPSite("http://Server_Name/sites/Site_Name/Subsite_Name/default.aspx")
    ...
End Using
using (SPSite oSiteCollection = new SPSite("http://Server_Name/sites/Site_Name/Subsite_Name/default.aspx"))
{
    ...
}

The next code example creates an SPSite object using System.Environment.MachineName.

Using oSiteCollection As New SPSite("http://" + System.Environment.MachineName + "/sites/Site_Name")
    ...
End Using
using (SPSite oSiteCollection = new SPSite("http://" + System.Environment.MachineName + "/sites/Site_Name"))
{
    ...
}

Note

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

See also

Reference

SPSite class

SPSite members

SPSite overload

Microsoft.SharePoint namespace