Function: keymap-prompt

keymap-prompt is a function defined in keymap.c.

Signature

(keymap-prompt MAP)

Documentation

Return the prompt-string of a keymap MAP.

If non-nil, the prompt is shown in the echo-area when reading a key-sequence to be looked-up in this keymap.

View in manual

Probably introduced at or before Emacs version 22.1.

Source Code

// Defined in /usr/src/emacs/src/keymap.c
{
  map = get_keymap (map, 0, 0);
  while (CONSP (map))
    {
      Lisp_Object tem = XCAR (map);
      if (STRINGP (tem))
	return tem;
      else if (KEYMAPP (tem))
	{
	  tem = Fkeymap_prompt (tem);
	  if (!NILP (tem))
	    return tem;
	}
      map = XCDR (map);
    }
  return Qnil;
}