# format_replace

- **Language:** C
- **Kind:** function
- **Source:** https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4015
- **Page:** https://libtmux.org/en/tmux/3.2a/reference/c-function-format-c-format_replace/

```c
static int format_replace(struct format_expand_state *, const char *, size_t, char **, size_t *, size_t *)
```

## Parameters

- `es` (`struct format_expand_state *`)
- `key` (`const char *`)
- `keylen` (`size_t`)
- `buf` (`char **`)
- `len` (`size_t *`)
- `off` (`size_t *`)

## Called by

- [`format_expand1`](/en/tmux/3.2a/reference/c-function-format-c-format_expand1/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4527)

## Calls

- [`format_build_modifiers`](/en/tmux/3.2a/reference/c-function-format-c-format_build_modifiers/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4036)
- [`format_choose`](/en/tmux/3.2a/reference/c-function-format-c-format_choose/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4207)
- [`format_expand1`](/en/tmux/3.2a/reference/c-function-format-c-format_expand1/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4163)
- [`format_find`](/en/tmux/3.2a/reference/c-function-format-c-format_find/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4270)
- [`format_free_modifiers`](/en/tmux/3.2a/reference/c-function-format-c-format_free_modifiers/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4417)
- [`format_logging`](/en/tmux/3.2a/reference/c-function-format-c-format_logging/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4039)
- [`format_loop_panes`](/en/tmux/3.2a/reference/c-function-format-c-format_loop_panes/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4183)
- [`format_loop_sessions`](/en/tmux/3.2a/reference/c-function-format-c-format_loop_sessions/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4175)
- [`format_loop_windows`](/en/tmux/3.2a/reference/c-function-format-c-format_loop_windows/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4179)
- [`format_match`](/en/tmux/3.2a/reference/c-function-format-c-format_match/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4256)
- [`format_replace_expression`](/en/tmux/3.2a/reference/c-function-format-c-format_replace_expression/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4310)
- [`format_search`](/en/tmux/3.2a/reference/c-function-format-c-format_search/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4202)
- [`format_session_name`](/en/tmux/3.2a/reference/c-function-format-c-format_session_name/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4191)
- [`format_skip`](/en/tmux/3.2a/reference/c-function-format_skip/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4262)
- [`format_strip`](/en/tmux/3.2a/reference/c-function-format-c-format_strip/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4112)
- [`format_sub`](/en/tmux/3.2a/reference/c-function-format-c-format_sub/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4346)
- [`format_trim_left`](/en/tmux/3.2a/reference/c-function-format_trim_left/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4356)
- [`format_trim_right`](/en/tmux/3.2a/reference/c-function-format_trim_right/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4366)
- [`format_true`](/en/tmux/3.2a/reference/c-function-format_true/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4216)
- [`format_window_name`](/en/tmux/3.2a/reference/c-function-format-c-format_window_name/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4187)
- [`strtonum`](/en/tmux/3.2a/reference/c-function-strtonum/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4066)
- [`utf8_padcstr`](/en/tmux/3.2a/reference/c-function-utf8_padcstr/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4379)
- [`utf8_rpadcstr`](/en/tmux/3.2a/reference/c-function-utf8_rpadcstr/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4384)
- [`xasprintf`](/en/tmux/3.2a/reference/c-function-xasprintf/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4168)
- [`xreallocarray`](/en/tmux/3.2a/reference/c-function-xreallocarray/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4059)
- [`xstrdup`](/en/tmux/3.2a/reference/c-function-xstrdup/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4157)
- [`xstrndup`](/en/tmux/3.2a/reference/c-function-xstrndup/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4033)

## Other function references

- [`format_copy_state`](/en/tmux/3.2a/reference/c-function-format-c-format_copy_state/) (function)
- [`format_width`](/en/tmux/3.2a/reference/c-function-format_width/) (function)

## Referenced declarations

- [`FORMAT_BASENAME`](/en/tmux/3.2a/reference/c-define-format-c-format_basename/) (constant)
- [`FORMAT_CHARACTER`](/en/tmux/3.2a/reference/c-define-format-c-format_character/) (constant)
- [`FORMAT_DIRNAME`](/en/tmux/3.2a/reference/c-define-format-c-format_dirname/) (constant)
- [`FORMAT_EXPAND`](/en/tmux/3.2a/reference/c-define-format-c-format_expand/) (constant)
- [`format_expand_state`](/en/tmux/3.2a/reference/c-struct-format_expand_state/) (struct)
- [`FORMAT_EXPAND_TIME`](/en/tmux/3.2a/reference/c-define-format-c-format_expand_time/) (constant)
- [`FORMAT_EXPANDTIME`](/en/tmux/3.2a/reference/c-define-format-c-format_expandtime/) (constant)
- [`FORMAT_LENGTH`](/en/tmux/3.2a/reference/c-define-format-c-format_length/) (constant)
- [`FORMAT_LITERAL`](/en/tmux/3.2a/reference/c-define-format-c-format_literal/) (constant)
- [`format_log`](/en/tmux/3.2a/reference/c-define-format-c-format_log/) (constant)
- [`FORMAT_PANES`](/en/tmux/3.2a/reference/c-define-format-c-format_panes/) (constant)
- [`FORMAT_PRETTY`](/en/tmux/3.2a/reference/c-define-format-c-format_pretty/) (constant)
- [`FORMAT_QUOTE_SHELL`](/en/tmux/3.2a/reference/c-define-format-c-format_quote_shell/) (constant)
- [`FORMAT_QUOTE_STYLE`](/en/tmux/3.2a/reference/c-define-format-c-format_quote_style/) (constant)
- [`FORMAT_SESSION_NAME`](/en/tmux/3.2a/reference/c-define-format-c-format_session_name/) (constant)
- [`FORMAT_SESSIONS`](/en/tmux/3.2a/reference/c-define-format-c-format_sessions/) (constant)
- [`FORMAT_TIMESTRING`](/en/tmux/3.2a/reference/c-define-format-c-format_timestring/) (constant)
- [`FORMAT_WIDTH`](/en/tmux/3.2a/reference/c-define-format-c-format_width/) (constant)
- [`FORMAT_WINDOW_NAME`](/en/tmux/3.2a/reference/c-define-format-c-format_window_name/) (constant)
- [`FORMAT_WINDOWS`](/en/tmux/3.2a/reference/c-define-format-c-format_windows/) (constant)
- [`format_expand_state.ft`](/en/tmux/3.2a/reference/c-struct-format_expand_state-ft/) (attribute)
- [`window_pane.id`](/en/tmux/3.2a/reference/c-struct-window_pane-id/) (attribute)
- [`format_modifier.modifier`](/en/tmux/3.2a/reference/c-struct-format_modifier-modifier/) (attribute)
- [`format_tree.wp`](/en/tmux/3.2a/reference/c-struct-format_tree-wp/) (attribute)