DriveCmdletProvider.RemoveDrive(PSDriveInfo) Method

Reference

Definition

Namespace:: System.Management.Automation.Provider

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gives the provider an opportunity to clean up any provider specific data for the drive that is going to be removed.

protected:
 virtual System::Management::Automation::PSDriveInfo ^ RemoveDrive(System::Management::Automation::PSDriveInfo ^ drive);

protected virtual System.Management.Automation.PSDriveInfo RemoveDrive (System.Management.Automation.PSDriveInfo drive);

abstract member RemoveDrive : System.Management.Automation.PSDriveInfo -> System.Management.Automation.PSDriveInfo
override this.RemoveDrive : System.Management.Automation.PSDriveInfo -> System.Management.Automation.PSDriveInfo

Protected Overridable Function RemoveDrive (drive As PSDriveInfo) As PSDriveInfo

Parameters

drive: PSDriveInfo

The Drive object the represents the mounted drive.

Returns

PSDriveInfo

If the drive can be removed it should return the drive that was passed in. If the drive cannot be removed, null should be returned or an exception should be thrown.

The default implementation returns the drive that was passed.

Remarks

A provider should override this method to free any resources that may be associated with the drive being removed.

Applies to

Share via