TmuxOptions.GetAsync
Reads one option.
Source and package
- Module
- LibTmux
- Declared in
- TmuxOptions
- Package
- LibTmux
- Source
- src/LibTmux/Options/TmuxOptions.cs
- GetAsync ( request : Get
Option , cancellationToken : CancellationRequest Token ) Task<IReadOnly <TmuxList Option >> ( key : TmuxOption <T> , cancellationToken : CancellationKey Token ) Task<T> -
Description#
Unescaping a doubled dollar sign needs the connected tmux's version, so a table reached from a handle that has not found a live server yet discovers one first.
- Parameters
-
-
request ( Get
Option ) – Which option to read, and how. (forRequest GetAsync(request, cancellationToken)) -
cancellationToken ( Cancellation
Token ) – Cancels the tmux command. -
key ( Tmux
Option <T> ) – The option and how to read it. (forKey GetAsync(key, cancellationToken))
-
- Returns
-
Every entry tmux reported for the name: one for an ordinary option, and one per set index for an array. (for
GetAsync(request, cancellationToken))The value tmux applies here, set in this scope or inherited from a parent. (for
GetAsync(key, cancellationToken)) - Raises
-
-
Tmux
Option – tmux rejected the option name. (forException GetAsync(request, cancellationToken)) -
Tmux
Option – tmux rejected the name, reported no value, or reported one the key cannot read. (forException GetAsync(key, cancellationToken))
-
Discussed in Options and hooks