Previous: , Up: Temporary Displays   [Index]


H.1.4 Momentary Display

Function: momentary-string-display string position &optional char message

This function momentarily displays string in the current buffer at position.

STRING

string to display in current buffer

POS

Position in current buffer to display string at. ‘POS’ can be a marker, in which case only its value is used; its buffer is ignored.

EXIT-CHAR

Optional third arg ‘EXIT-CHAR’ can be a character, event or event description list, defaulting to ‘SPC’. If the next input event is ‘CHAR’, it is ignored and the function returns, otherwise it is available as input.

MESSAGE

If non-nil, display the ‘MESSAGE’ in the echo area while ‘STRING’ is displayed. If nil, instructions to type ‘CHAR’ are displayed in the echo area.

RETURN

This function’s return value is not meaningful.