Function: field-beginning

field-beginning is a function defined in editfns.c.

Signature

(field-beginning &optional POS ESCAPE-FROM-EDGE LIMIT)

Documentation

Return the beginning of the field surrounding POS.

A field is a region of text with the same field property. If POS is nil, the value of point is used for POS. If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its field, then the beginning of the *previous* field is returned. If LIMIT is non-nil, it is a buffer position; if the beginning of the field is before LIMIT, then LIMIT will be returned instead.

View in manual

Probably introduced at or before Emacs version 21.1.

Source Code

// Defined in /usr/src/emacs/src/editfns.c
{
  ptrdiff_t beg;
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
  return make_fixnum (beg);
}