Share via


SPAlternateUrlCollection class

Represents a collection of SPAlternateUrl objects.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Administration.SPAutoSerializingObject
    Microsoft.SharePoint.Administration.SPPersistedObject
      Microsoft.SharePoint.Administration.SPAlternateUrlCollection

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

Syntax

'Declaration
<GuidAttribute("9920F486-2FF4-4d10-9532-E01979826585")> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public Class SPAlternateUrlCollection _
    Inherits SPPersistedObject _
    Implements ICollection(Of SPAlternateUrl), IEnumerable(Of SPAlternateUrl),  _
    IEnumerable, IBackupRestore
'Usage
Dim instance As SPAlternateUrlCollection
[GuidAttribute("9920F486-2FF4-4d10-9532-E01979826585")]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public class SPAlternateUrlCollection : SPPersistedObject, 
    ICollection<SPAlternateUrl>, IEnumerable<SPAlternateUrl>, IEnumerable, 
    IBackupRestore

Remarks

To create an alternate request URL, use the SPAlternateUrl constructor to instantiate a URL object, and the Add method to add the object to the collection of URL objects for the specified zone. A request URL can be specified only once per Windows SharePoint Services farm.

Use an indexer to return a single URL from the collection. For example, assuming the collection is assigned to a variable named myUrls, use myUrls[index] in Microsoft Visual C# or myUrls(index) in Microsoft Visual Basic, where index is either the index number of the item in the collection, or a string containing the incoming URL of the request.

Thread safety

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

See also

Reference

SPAlternateUrlCollection members

Microsoft.SharePoint.Administration namespace