SPSite.PortalName Property
Gets or sets the name of a portal. (Read-only in sandboxed solutions.)
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
Public Property PortalName As String
Get
Set
'Usage
Dim instance As SPSite
Dim value As String
value = instance.PortalName
instance.PortalName = value
public string PortalName { get; set; }
Property Value
Type: System.String
A string that contains the portal name.
Remarks
The PortalName property must be set together with the PortalUrl property to establish a connection to a portal site. The PortalUrl property must be specified first and the PortalName property second.
Examples
The following code example uses the PortalName property to establish a connection to a portal site from the specified site collection.
Using oSiteCollection As New SPSite("http://Server_Name/sites/Site_Name")
oSiteCollection.PortalUrl = "http://Portal_Site/"
oSiteCollection.PortalName = "Portal_Name"
End Using
using (SPSite oSiteCollection = new SPSite("http://Server_Name/sites/Site_Name"))
{
oSiteCollection.PortalUrl = "http://Portal_Site/";
oSiteCollection.PortalName = "Portal_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.