LibTmux.Update-TmuxPane
LibTmux\Update-TmuxPane Refresh a pane into a replacement captured object.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/UpdateTmuxPaneCommand.cs
- Update-TmuxPane [-Pane] <Lib
Tmux > [<Common.Pane Parameters >] -
Description#
Acquire current pane data through the native core handle. Return a new
Paneand leave the original capture unchanged. This is an explicit read operation, so it does not require mutation confirmation.Notes
The owning endpoint and server generation remain part of the handle. A disappeared pane or stale generation writes a per-target error; use
-ErrorActionStop to terminate.Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Pane: Native pipeline type for this command. - Outputs
-
LibTmux.Pane
Examples#
Example 1 Refresh the first pane on the existing server identified by
$SocketPath. View sourceTerminal window LibTmux\New-TmuxServer -SocketPath $SocketPath |LibTmux\Get-TmuxPane |Select-Object -First 1 |LibTmux\Update-TmuxPane- Parameters
-
-
The pane whose current state is read.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.Pane: Native pipeline type for this command.
Discussed in Capture, refresh and raw commands , Read tmux objects