Share via


SPCmdletPipeBind<TCmdletObject>.Read Method

Retrieves the input object that is associated with the current pipebind object.

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel := True)> _
Public MustOverride Function Read As TCmdletObject
'Usage
Dim instance As SPCmdletPipeBind
Dim returnValue As TCmdletObject

returnValue = instance.Read()
[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel = true)]
public abstract TCmdletObject Read()

Return Value

Type: TCmdletObject
Returns the object associated with the current pipebind object, or returns a null reference (Nothing in Visual Basic) if the object cannot be found.

Remarks

This method should locate the object based on the unique identifying information that is supplied to it, for example, a GUID. If the object was placed on the pipeline, the object can serve as its own unique identifier.

This is an abstract method. All derived classes should override this method and provide their own implementation.

See Also

Reference

SPCmdletPipeBind<TCmdletObject> Class

SPCmdletPipeBind<TCmdletObject> Members

Microsoft.SharePoint.PowerShell Namespace