Window.UnlinkAsync
Removes this window's link to the session it was read through.
Source and package
- UnlinkAsync ( killIfLast : bool , cancellationToken : Cancellation
Token ) Task ( killIfLast : bool , expectedPaneIds : IReadOnly <PaneList Id > , cancellationToken : CancellationToken ) Task -
Description#
tmux refuses to unlink a window that belongs to only one session unless it is allowed to destroy it. A guard in the native queue checks the captured session/index still names this window before unlinking it.
- Parameters
-
-
killIfLast ( bool ) – Whether the window dies when this was its last link.
-
cancellationToken ( Cancellation
Token ) – Cancels the tmux command. -
expectedPaneIds ( IRead
Only <PaneList Id > ) – The nonempty, distinct pane IDs expected in the window, in any order. (forUnlinkAsync(killIfLast, expectedPaneIds, cancellationToken))
-
- Raises
-
-
Argument
Exception – The IDs are empty, duplicated, or exceed the native command byte budget. (forUnlinkAsync(killIfLast, expectedPaneIds, cancellationToken)) -
Tmux
Command – The placement or pane membership changed, or tmux refused the unlink. (forException UnlinkAsync(killIfLast, expectedPaneIds, cancellationToken))
-
tmux command
unlink-windowIn other ports Unlink a window from a session
- Python
libtmux.Window.unlink - Ruby No source-verified Ruby equivalent is recorded for this operation.
- Lua
libtmux.WindowLink:unlink - TypeScript
window.Window.unlink - Rust
window.Window.unlink - Go
tmux.Window.Unlink - Java
io.github.libtmux.Window.unlink - C++
libtmux::Window::unlink - Swift
Server.unlink(_:) - Kotlin No source-verified Kotlin equivalent is recorded for this operation.
- Scala No source-verified Scala equivalent is recorded for this operation.
- F# No source-verified F# equivalent is recorded for this operation.