SPPrefixPipeBind Class

Represents a binding for pipeline or command-line input parameters to a Windows PowerShell cmdlet. The binding that this class represents is to input parameters specific to a SharePoint FoundationSPPrefix object. For more information about PipeBind objects, see Key Concepts for Writing Cmdlets for the SharePoint Management Shell.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.PowerShell.SPCmdletPipeBind<SPPrefix>
    Microsoft.SharePoint.PowerShell.SPPrefixPipeBind

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

Syntax

'Declaration
Public NotInheritable Class SPPrefixPipeBind _
    Inherits SPCmdletPipeBind(Of SPPrefix)
'Usage
Dim instance As SPPrefixPipeBind
public sealed class SPPrefixPipeBind : SPCmdletPipeBind<SPPrefix>

Remarks

SPPrefixPipeBind class supports the SPPrefix class; the SPPrefix class represents a specified relative URL that is used to determine segments of the URL under which SPSite objects may be created.

With regard to the SPPrefix object, when a request to a Web application is received by the Web server, Microsoft SharePoint Foundation looks at the URL path of the request to determine whether the request should be handled by SharePoint Foundation or by IIS. Inclusions specify what URL paths are handled by Microsoft SharePoint Foundation.

Given this, you can use the prefixes of the SPWebApplication class to return the collection of prefixes for the Web application. Use an indexer to return a single prefix from the collection. For example, if the collection is assigned to a variable named myPrefixes, use myPrefixes[index] in C#, or myPrefixes(index) in Visual Basic .NET, where index is the index number of the prefix in the collection.

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

SPPrefixPipeBind Members

Microsoft.SharePoint.PowerShell Namespace