---

4.5 Using Infix Arguments ¶

The functions and the variables described below allow suffix commands to access the value of the transient from which they were invoked; which is the value of its infix arguments. These variables are set when the user invokes a suffix command that exits the transient, but before actually calling the command.

When returning to the command-loop after calling the suffix command, the arguments are reset to nil (which causes the function to return nil too).

Like for Emacs’s prefix arguments, it is advisable, but not mandatory, to access the infix arguments inside the command’s interactive form. The preferred way of doing that is to call the transient-args function, which for infix arguments serves about the same purpose as prefix-arg serves for prefix arguments.

Function: transient-args prefix ¶

This function returns the value of the transient prefix command PREFIX.

If the current command was invoked from the transient prefix command PREFIX, then it returns the active infix arguments. If the current command was not invoked from PREFIX, then it returns the set, saved or default value for PREFIX.

PREFIX may also be a list of prefixes. If no prefix is active, the fallback value of the first of these prefixes is used.

The generic function transient-prefix-value is used to determine the returned value.

This function is intended to be used by suffix commands, whether they are invoked from a menu or not. It is not intended to be used when setting up a menu and its suffixes, in which case transient-get-value should be used.

Function: transient-get-value ¶

This function returns the value of the erant prefix.

This function is intended to be used when setting up a menu and its suffixes. It is not intended to be used when a suffix command is invoked, whether from a menu or not, in which case transient-args should be used. In other words, use this, e.g., in a suffixes :if* or :inapt-if* predicate and :description function, but never in its interactive form or function body.

Function: transient-arg-value arg args ¶

This function returns the value of ARG as it appears in ARGS.

For a switch a boolean is returned. For an option the value is returned as a string, using the empty string for the empty value, or nil if the option does not appear in ARGS.

Function: transient-suffixes prefix ¶

This function returns the suffixes of the transient prefix command PREFIX. This is a list of objects. This function should only be used if you need the objects (as opposed to just their values) and if the current command is not being invoked from PREFIX.