PortalUrlCollection Class

The PortalUrlCollection class represents a collection of PortalUrl objects in the topology of a server farm.

System.Object

Microsoft.SharePoint.Portal.Topology.SqlCollectionBase

  Microsoft.SharePoint.Portal.Topology.TopologyObjectCollectionBase

      **Microsoft.SharePoint.Portal.Topology.PortalUrlCollection**

Public Methods

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

Name Description
Add(Microsoft.SharePoint.Portal.Topology.PortalUrl) Adds the specified portal site URL to the topology for the server farm.
Remove(System.Guid) Removes the specified portal site URL from the topology for the server farm.

Public Properties

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

Name Data Type Description
Item(System.Guid) Microsoft.SharePoint.Portal.Topology.PortalUrl Gets a PortalUrl object specified by unique identifier.
Item(System.Uri) Microsoft.SharePoint.Portal.Topology.PortalUrl Gets a PortalUrl object specified by URL.

Thread Safety

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

Remarks

Use the PortalUrlCollection to manage the URLs of portal sites in the topology of a server farm. The PortalUrlCollection corresponds to the list of URLs in the PortalUrls table of the configuration database for a server farm.

See the PortalUrl Class for additional information about the PortalUrl object.

To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.

In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.

Requirements

Namespace: Microsoft.SharePoint.Portal.Topology

Platforms: Microsoft Windows Server 2003

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

Security: Code Access Security