ColorConsole [Version 1.7.1000] PowerShell 2.0-Export
Microsoft Windows [Version 6.1.7600]
Copyright (c) 2009 Microsoft Corporation.
C:\Windows-7>Powershell get-help Remove-PSDrive -full
# NAME
Remove-PSDrive
# SYNOPSIS
Removes a Windows PowerShell drive from its location.
# SYNTAX
Remove-PSDrive [-LiteralName
] <string
[]>
[-Force
] [-PSProvider <string
[]>
] [-Scope <string>
] [-Confirm
] [-WhatIf
] [-UseTransaction
] [<CommonParameters>
]
Remove-PSDrive [-Name
] <string
[]>
[-Force
] [-PSProvider <string
[]>
] [-Scope <string>
] [-Confirm
] [-WhatIf
] [-UseTransaction
] [<CommonParameters>
]
# DESCRIPTION
The
Remove-PSDrive cmdlet deletes Windows PowerShell drives that you created by using New-PSDrive.
Remove-PSDrive cannot delete Windows drives or mapped network drives created by using other methods and it cannot delete the current working drive.
# PARAMETERS
-Force [<SwitchParameter>
]
Allows the cmdlet to remove the current Windows PowerShell drive.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LiteralName <string
[]>
Specifies the name of the Windows PowerShell drive.
The value of LiteralName is used exactly as typed. No characters are interpreted as wildcards. If the name includes escape characters, enclose it in single quotation marks
('
). Single quotation marks instruct Windows PowerShell not to interpret any characters as escape sequences.
Required? true
Position? 1
Default value
Accept pipeline input? true
(ByPropertyName
)
Accept wildcard characters? false
-Name <string
[]>
Specifies the names of the Windows PowerShell drives to remove. Do not type a colon
(:
) after the drive name.
Required? true
Position? 1
Default value
Accept pipeline input? true
(ByPropertyName
)
Accept wildcard characters? false
-PSProvider <string
[]>
Removes all of the Windows PowerShell drives associated with the specified Windows PowerShell provider.
Required? false
Position? named
Default value
Accept pipeline input? true
(ByPropertyName
)
Accept wildcard characters? false
-Scope <string>
Accepts an index that identifies the scope from which the drive is being removed.
Required? false
Position? named
Default value
Accept pipeline input? true
(ByPropertyName
)
Accept wildcard characters? false
-Confirm [<SwitchParameter>
]
Prompts you for confirmation before executing the command.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>
]
Describes what would happen if you executed the command without actually executing the command.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>
]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see about_Transactions.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"
get-help about_commonparameters".
# INPUTS
System.Management.Automation.PSDriveInfo
You can pipe a drive object to Remove-PSDrive.
# OUTPUTS
None
This cmdlet does not return any output.
# NOTES
The
Remove-PSDrive cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type "
get-psprovider". For more information, see about_Providers.
# EXAMPLE 1
C:\PS>remove-psdrive -name smp
# Description
-----------
This command removes a Windows PowerShell drive named "smp".
RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113376
about_Providers
Get-PSDrive
New-PSDrive
C:\Windows>powershell
get-help Get-PSDrive -full
