Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WMF content reorg #4307

Merged
merged 7 commits into from
May 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18,857 changes: 9,654 additions & 9,203 deletions .openpublishing.redirection.json

Large diffs are not rendered by default.

59 changes: 38 additions & 21 deletions reference/5.0/Microsoft.PowerShell.Management/Get-Clipboard.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
ms.date: 06/09/2017
schema: 2.0.0
locale: en-us
keywords: powershell,cmdlet
online version: http://go.microsoft.com/fwlink/?LinkId=526219
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
title: Get-Clipboard
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
keywords: powershell,cmdlet
locale: en-us
Module Name: Microsoft.PowerShell.Management
ms.date: 05/15/2019
online version: http://go.microsoft.com/fwlink/?LinkId=526219
schema: 2.0.0
title: Get-Clipboard
---
# Get-Clipboard

Expand All @@ -20,34 +21,49 @@ Get-Clipboard [-Format <ClipboardFormat>] [-TextFormatType <TextDataFormat>] [-R

## DESCRIPTION

The **Get-Clipboard** cmdlet gets the current Windows clipboard entry.
The `Get-Clipboard` cmdlet gets the current Windows clipboard entry.

## EXAMPLES

### Example 1: Get the content of the clipboard and display it to the command-line

In this example we have right-clicked on an image in a browser and chose the **Copy** action. The
following command displays the link, as a URL, of the image that is stored in the clipboard.

```powershell
Get-Clipboard
```
PS C:\> Get-Clipboard
This is a test string.

```Output
https://en.wikipedia.org/wiki/PowerShell
```

This command displays the contents of the clipboard to the command-line.
### Example 2: Get the content of the clipboard in a specific format

### Example 2: Get the content of the clipboard and display it to the command-line
In this example we copied files to the clipboard in Windows Explorerby selecting them and pressing
<kbd>Ctrl-C</kbd>. Using the following command, you can access the contents of the clipboard as a
list of files:

```powershell
Get-Clipboard -Format FileDropList
```
PS C:\> Get-Clipboard
https://en.wikipedia.org/wiki/PowerShell
```

This command displays the link, as a URL, of the image that is stored in the clipboard.
```Output
Directory: C:\Git\PS-Docs\PowerShell-Docs\wmf

Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/7/2019 1:11 PM 10010 TOC.yml
-a---- 11/18/2016 10:10 AM 53 md.style
-a---- 5/6/2019 9:32 AM 4177 overview.md
-a---- 6/28/2018 2:28 PM 345 README.md
```

## PARAMETERS

### -Format

Specifies the type, or format, of the clipboard.
The acceptable values for this parameter are:
Specifies the type, or format, of the clipboard. The acceptable values for this parameter are:

- Text
- FileDropList
Expand Down Expand Up @@ -85,8 +101,7 @@ Accept wildcard characters: False

### -TextFormatType

Specifies the text data format type of the clipboard.
The acceptable values for this parameter are:
Specifies the text data format type of the clipboard. The acceptable values for this parameter are:

- Text
- UnicodeText
Expand All @@ -109,7 +124,9 @@ Accept wildcard characters: False

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
84 changes: 41 additions & 43 deletions reference/5.0/Microsoft.PowerShell.Management/Set-Clipboard.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
ms.date: 06/09/2017
schema: 2.0.0
locale: en-us
keywords: powershell,cmdlet
online version: http://go.microsoft.com/fwlink/?LinkId=526220
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
title: Set-Clipboard
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
keywords: powershell,cmdlet
locale: en-us
Module Name: Microsoft.PowerShell.Management
ms.date: 06/09/2017
online version: http://go.microsoft.com/fwlink/?LinkId=526220
schema: 2.0.0
title: Set-Clipboard
---
# Set-Clipboard

Expand Down Expand Up @@ -40,26 +41,24 @@ Set-Clipboard [-Append] -LiteralPath <String[]> [-WhatIf] [-Confirm] [<CommonPar

## DESCRIPTION

The **Set-Clipboard** cmdlet sets the current Windows clipboard entry.
The `Set-Clipboard` cmdlet sets the current Windows clipboard entry.

## EXAMPLES

### Example 1: Copy text to the clipboard

```powershell
Set-Clipboard -Value "This is a test string"
```
PS C:\> Set-Clipboard -Value "This is a test string"
```

This command copies a string to the clipboard.

### Example 2: Copy the contents of a directory to the clipboard

```
PS C:\> Set-Clipboard -Path "C:\Staging\"
```

This command copies the content of the specified folder to the clipboard.

```powershell
Set-Clipboard -Path "C:\Staging\"
```

## PARAMETERS

### -Append
Expand All @@ -78,29 +77,12 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -LiteralPath

Specifies the path to the item that is copied to the clipboard.
Unlike *Path*, the value of *LiteralPath* is used exactly as it is typed.
No characters are interpreted as wildcards.
If the path includes escape characters, enclose it in single quotation marks.
Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.
Specifies the path to the item that is copied to the clipboard. Unlike **Path**, the value of
**LiteralPath** is used exactly as it is typed. No characters are interpreted as wildcards. If the
path includes escape characters, enclose it in single quotation marks. Single quotation marks tell
Windows PowerShell not to interpret any characters as escape sequences.

```yaml
Type: String[]
Expand All @@ -116,8 +98,7 @@ Accept wildcard characters: False

### -Path

Specifies the path to the item that is copied to the clipboard.
Wildcard characters are permitted.
Specifies the path to the item that is copied to the clipboard. Wildcard characters are permitted.

```yaml
Type: String[]
Expand All @@ -128,7 +109,7 @@ Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Accept wildcard characters: True
```

### -Value
Expand All @@ -147,10 +128,25 @@ Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Shows what would happen if the cmdlet runs. The cmdlet is not run.

```yaml
Type: SwitchParameter
Expand All @@ -166,7 +162,9 @@ Accept wildcard characters: False

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
54 changes: 38 additions & 16 deletions reference/5.1/Microsoft.PowerShell.Management/Get-Clipboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
keywords: powershell,cmdlet
locale: en-us
Module Name: Microsoft.PowerShell.Management
ms.date: 06/09/2017
ms.date: 05/15/2019
online version: http://go.microsoft.com/fwlink/?LinkId=526219
schema: 2.0.0
title: Get-Clipboard
---

# Get-Clipboard

## SYNOPSIS
Expand All @@ -21,31 +20,50 @@ Get-Clipboard [-Format <ClipboardFormat>] [-TextFormatType <TextDataFormat>] [-R
```

## DESCRIPTION
The **Get-Clipboard** cmdlet gets the current Windows clipboard entry.

The `Get-Clipboard` cmdlet gets the current Windows clipboard entry.

## EXAMPLES

### Example 1: Get the content of the clipboard and display it to the command-line
```
PS C:\> Get-Clipboard
This is a test string.
```

This command displays the contents of the clipboard to the command-line.
In this example we have right-clicked on an image in a browser and chose the **Copy** action. The
following command displays the link, as a URL, of the image that is stored in the clipboard.

### Example 2: Get the content of the clipboard and display it to the command-line
```powershell
Get-Clipboard
```
PS C:\> Get-Clipboard

```Output
https://en.wikipedia.org/wiki/PowerShell
```

This command displays the link, as a URL, of the image that is stored in the clipboard.
### Example 2: Get the content of the clipboard in a specific format

In this example we copied files to the clipboard in Windows Explorerby selecting them and pressing
<kbd>Ctrl-C</kbd>. Using the following command, you can access the contents of the clipboard as a
list of files:

```powershell
Get-Clipboard -Format FileDropList
```

```Output
Directory: C:\Git\PS-Docs\PowerShell-Docs\wmf

Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/7/2019 1:11 PM 10010 TOC.yml
-a---- 11/18/2016 10:10 AM 53 md.style
-a---- 5/6/2019 9:32 AM 4177 overview.md
-a---- 6/28/2018 2:28 PM 345 README.md
```

## PARAMETERS

### -Format
Specifies the type, or format, of the clipboard.
The acceptable values for this parameter are:

Specifies the type, or format, of the clipboard. The acceptable values for this parameter are:

- Text
- FileDropList
Expand All @@ -66,6 +84,7 @@ Accept wildcard characters: False
```

### -Raw

Indicates that this cmdlet ignores newline characters and gets the entire contents of the clipboard.

```yaml
Expand All @@ -81,8 +100,8 @@ Accept wildcard characters: False
```

### -TextFormatType
Specifies the text data format type of the clipboard.
The acceptable values for this parameter are:

Specifies the text data format type of the clipboard. The acceptable values for this parameter are:

- Text
- UnicodeText
Expand All @@ -104,7 +123,10 @@ Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
Loading