Function: frame-parameter

frame-parameter is a function defined in frame.c.

Signature

(frame-parameter FRAME PARAMETER)

Documentation

Return FRAME's value for parameter PARAMETER.

If FRAME is nil or omitted, it defaults to the selected frame.

View in manual

Probably introduced at or before Emacs version 22.2.

Aliases

ps-frame-parameter (obsolete since 28.1) allout-frame-property (obsolete since 28.1) dframe-frame-parameter (obsolete since 27.1)

Source Code

// Defined in /usr/src/emacs/src/frame.c
{
  struct frame *f = decode_any_frame (frame);

  CHECK_SYMBOL (parameter);

  XSETFRAME (frame, f);

  if (!FRAME_LIVE_P (f))
    return Qnil;

  /* Try first to convert PARAMETER's value from values recorded in the
     various fields of the frame object.  If no such value, search in
     FRAME->param_alist.  */
  Lisp_Object value = frame_get_param_value (f, parameter);
  if (EQ (value, Qunbound))
    value = Fcdr (Fassq (parameter, f->param_alist));

  return value;
}