SPCmdletPipeBind<TCmdletObject> Class

  • Article

An abstract class that represents a binding for pipeline and command-line input to PowerShell cmdlet parameters. This generic base class for SharePoint pipebind classes takes a generic type of TCmdletObject. The SPCmdletPipeBind<TCmdletObject> class provides the abstract methods Read and Discover. The cmdlet classes use the Read method to retrieve results. The Read method retrieves the object instance that represents the parameters associated with the current pipebind object; the Discover method populates the information that is required to retrieve or recreate the given object. All derived classes must override and implement these methods.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.PowerShell.SPCmdletPipeBind<TCmdletObject>
    

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel := True)> _
Public MustInherit Class SPCmdletPipeBind(Of TCmdletObject As Class)
'Usage
Dim instance As SPCmdletPipeBind(Of TCmdletObject)

[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel = true)]
public abstract class SPCmdletPipeBind<TCmdletObject>
where TCmdletObject : class

Type Parameters

  • TCmdletObject
    An object representing the source of the data received from the pipeline or command-line parameters.

Remarks

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 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

SPCmdletPipeBind<TCmdletObject> Members

Microsoft.SharePoint.PowerShell Namespace

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.PowerShell.SPCmdletPipeBind<TCmdletObject>
    SPAlternateUrlPipeBind
    SPAuthenticationProviderPipeBind
    SPClaimMappingPipeBind
    SPClaimProviderPipeBind
    SPDatabasePipeBind
    SPDatabaseServiceInstancePipeBind
    Microsoft.SharePoint.PowerShell.SPDeletedSitePipeBind
    SPDiagnosticsProviderPipeBind
    SPFarmPipeBind
    SPFeatureDefinitionPipeBind
    SPGroupPipeBind
    Microsoft.SharePoint.PowerShell.SPHealthAnalysisRuleInstancePipeBind
    SPManagedAccountPipeBind
    SPMobileMessagingAccountPipeBind
    Microsoft.SharePoint.PowerShell.SPPrefixPipeBind
    SPProcessAccountPipeBind
    SPQuotaTemplatePipeBind
    Microsoft.SharePoint.PowerShell.SPServerPipeBind
    SPServicePipeBind
    SPSiteAdministrationPipeBind
    Microsoft.SharePoint.PowerShell.SPSitePipeBind
    SPSolutionPipeBind
    SPTimerJobPipeBind
    SPTrustedIdentityTokenIssuerPipeBind
    SPTrustedServiceTokenIssuerPipeBind
    SPUsageApplicationPipeBind
    SPUsageDefinitionPipeBind
    SPUsageServicePipeBind
    SPUserPipeBind
    SPUserSolutionPipeBind
    Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind
    Microsoft.SharePoint.PowerShell.SPWebPipeBind
    SPWebTemplatePipeBind