Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Out-Clipboard

Out-Clipboard

pscx.dll

Synopsis

PSCX Cmdlet: Formats text via Out-String before placing in clipboard. Can also place string in clipboard as a file.

Syntax

Out-Clipboard [-InputObject] [-PasteFileName] [-AsFile] [-NoTrimEnd] [-Width] [<CommonParameters>]

Detailed Description

Formats text via Out-String before placing in clipboard. Can also place string in clipboard as a file.

Parameters

-InputObject <PSObject>

Accepts an object as input to the cmdlet. Enter a variable that contains the objects or type a command or expression that gets the objects.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-PasteFileName <String>

If AsFile switch is set, value supplied will be the name of the file placed in the clipboard.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AsFile <SwitchParameter>

Copies input as string and places on clipboard as a file. If PasteFileName is not supplied, the file will be named randomly with a .txt extension.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NoTrimEnd <SwitchParameter>

Suppresses trimming whitespace from the line of each line of input.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Width <Int32>

Specifies the number of characters in each line of output. Any additional characters are truncated, not wrapped. If you omit this parameter, the width is determined by the characteristics of the host. The default for the PowerShell.exe host is 120 (characters).

Aliases

None

Required?

false

Position

named

Default value

Same as Out-String -Width Default.

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

Set-Clipboard
Get-Clipboard
Write-Clipboard