SPServerPipeBind Class

Represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. The binding that this class represents is to input parameters specific to a SharePoint Server instance represented by an SPServer object. This class facilitates the binding to and handling of input parameters as objects, a GUID referencing an object, and as string representations.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.PowerShell.SPCmdletPipeBind<SPServer>
    Microsoft.SharePoint.PowerShell.SPServerPipeBind

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

Syntax

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

Remarks

This class is sealed and cannot be instantiated. To initialize classes that are derived from this class, use the constructor of the SPCmdletPipeBind<TCmdletObject> generic base class with a type parameter of SPServer to represent a physical computer in the SharePoint server farm. The SPCmdletPipeBind<TCmdletObject> parent class is an abstract class providing Read and Discover methods that this class overrides. The Read method is used to retrieve the server object instance that is associated with the current SPServerPipeBind object; the Discover method is used to populate the information that is required to retrieve or recreate the given server object. The cmdlet classes use these methods to retrieve results.

You can use this and other pipebind classes to simplify the handling of input parameters from the pipeline or the command line. Pipebind classes typically allow input parameters to be passed and referenced as objects, GUIDs that reference objects, or as string representations. Because pipebind types allow for the flexible representation of input data, each pipebind class must include constructors that initialize the object for the representations that it provides.

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

SPServerPipeBind Members

Microsoft.SharePoint.PowerShell Namespace

SPServer