Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_option:get_many/3

Read one scalar option from one to seven local rows on the same registered endpoint. Performs one bounded native sequence after validating every scope. Results follow input order; each entry is binary text or none for a missing local value. read_options/0 controls inheritance as in get/3.

Source and package
Qualified name
tmux_option:get_many/3
Declared in
tmux_option
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_option.erl
get_many(Scopes, Name, Options) -spec get_many([tmux_model:session() | tmux_model:window() | tmux_model:pane(), ...], binary(), read_options()) -> {ok, [binary() | none]} | {error, map()}.

Description#

Names use ASCII letters, digits, dots, underscores and hyphens, with an optional leading @ for user options. Global tables, arrays, indexed keys, hooks and command options are unsupported. Use get/3 for broader option reads and tmux_hook:get/3 for hooks. Invalid scopes, unsupported keys and different owners fail before dispatch.

Each read is bracketed by matching native target-ID observations. Unresolved or mismatched IDs reject the batch. The checks do not prove topology membership or completed destruction: older tmux may retain an unlinked pane through queued references. The sequence provides interval observations and the same server-incarnation guarantee as get/3. Ambient command configuration applies to both paths.

Stdout is bounded to 1 MiB and stderr to 64 KiB for the whole sequence, with the endpoint's 2500 ms command deadline. Seven 32 KiB values fit even under the qualified worst-case native quoting expansion. Larger external values may exceed that aggregate output bound. Any command, framing or decoding failure rejects the entire result, retaining native outcome and cleanup evidence. There is no partial-success result, hidden refresh or value cache.

Guides#

Pages that discuss get_many/3.

Esc

Type to search.

Reference previewOpen reference