$result(5)

NAME

$result - Various command return values

SYNOPSIS

$result returnValue

DESCRIPTION

$result is used to return the results of several commands:

buffer-info(2)


$result is set to the same output string as printed to the message-line by this command.

change-font(2)


$result is used to return the current or user select font.

copy-file(3)


$result is used to return the number of files and directories that were successfully copied or moved and the number that failed.

count-words(2)


$result is set to the same output string as printed to the message-line by this command.

delete-file(3)


$result is used to return the number of files and directories that were successfully deleted and the number that failed.

describe-key(2)


$result is set to the command bound to the given key.

file-op(2)


$result is used to return an error code when the command fails.

find(3)


$result is set to whether a match was found or a match count if option -c is used.

find-registry(2)


$result is used to return the name of a registry child node given the parent and index from the user.

generate-hash(2)


$result is set to the generated hash string.

generate-password(3)


$result is set to the generated password.

goto-alpha-mark(2)


$result is set to the list of all alpha marks in the current buffer when an argument of 0 is given.

grep(3)


$result is set to whether a match was found or a match count if option -c is used.

indent(2)


$result is set to the indent scheme used at current location when an argument of 2 is given.

ipipe-shell-command(2)

pipe-shell-command(2)

shell-command(2)


$result is set to the exit status of the system call. The combination of shell-command calls and return value checking can be used in a variety of ways, for example, to test the existence of a file:

set-variable %filename @ml "Enter file name" 
shell-command &cat "test -f " %filename 
!if &equ $result 0 
    ml-write "file exists" 
!else 
    ml-write "file does not exists" 
!endif 

In the case of ipipe-shell-command, $result is only set to the exit status of the system process during the final call to the buffer-ipipe-command, for more information see help for variable $buffer-ipipe(5).

major-mode(2)


$result is used to return information about a given major-mode.

mark-registry(2)


$result is used to return the full name of the given registry node.

osd(2)


$result is used to give and return information to osd item commands, information depends on the type of osd item.

osd-dialog(3)

osd-xdialog(3)


$result is used to return the button pressed by the user.

replace-string(2)

query-replace-string(2)

$result is used to return the number of substitutions, the final replace mode ('a' for all, 'l' for last or 'q' for query) and the replace with string in a list.

search-buffer(2)


$result is set to the number of matches found when numeric argument is 0.

set-char-mask(2)


$result is set to the characters in the given set.

show-region(2)


$result is set to the current status of the region when an argument of 0 is given to show-region.

spell(2)

$result is used to return information on the current word, the information depends on the argument given to spell.

@mx(4)


$result is set to the prompt to be used during the input.

$file-names(5)


$result is set to the absolute path of the $file-names query directory when the variable is set.

For more information see the help pages on referenced commands and variables.

NOTES

The current value of $result is lost on the next command call which uses it. As a call to create-callback(2) can cause the execution of a macro to interrupt another which is waiting for user input, the value of $result should be copied before getting user input.

SEE ALSO

buffer-info(2), change-font(2), copy-file(3), count-words(2), create-callback(2), delete-file(3), describe-key(2), file-op(2), find-registry(2), generate-hash(2), goto-alpha-mark(2), indent(2), ipipe-shell-command(2), major-mode(2), mark-registry(2), osd(2), pipe-shell-command(2), query-replace-string(2), replace-string(2), search-buffer(2), set-char-mask(2), shell-command(2), show-region(2), spell(2), generate-password(3), @mx(4), $file-names(5), $status(5).

(c) Copyright JASSPA 2026
Last Modified: 2026/02/21
Generated On: 2026/03/01