Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

C# API

method libtmux-dotnet latest

Session.GetWindowAsync

Namespace LibTmux

Reads one window in this session, throwing when it is absent.

View as Markdown

Source and package

Module: LibTmux
Declared in: Session
Package: LibTmux
Source: src/LibTmux/Session.Relations.cs

GetWindowAsync ( id : WindowId , cancellationToken : CancellationToken ) → Task<Window> ( target : string , cancellationToken : CancellationToken ) → Task<Window> methodasyncoverload2 overloads [source] ¶

Parameters

id ( WindowId ) – The window identifier. (for GetWindowAsync(id, cancellationToken))
cancellationToken ( CancellationToken ) – Cancels the tmux command.
target ( string ) – The window identifier or name. (for GetWindowAsync(target, cancellationToken))

Returns

The materialized window in this session.

Raises

TmuxObjectNotFoundException – This session has no matching window.
LibTmuxException – The lookup failed.