Function: line-beginning-position

line-beginning-position is a function defined in editfns.c.

Signature

(line-beginning-position &optional N)

Documentation

Return the position of the first character in the current line/field.

With optional argument N non-nil, move forward N - 1 lines first. This function is like pos-bol (which see), but respects fields.

This function constrains the returned position to the current field unless that position would be on a different line from the original, unconstrained result. If N is nil or 1, and a front-sticky field starts at point, the scan stops as soon as it starts. To ignore field boundaries, bind inhibit-field-text-motion to t.

This function does not move point.

Other relevant functions are documented in the buffer group.

View in manual

Probably introduced at or before Emacs version 20.4.

Shortdoc

;; buffer
(line-beginning-position)
    => 3263

Aliases

point-at-bol (obsolete since 29.1) hashcash-point-at-bol (obsolete since 28.1) mh-line-beginning-position (obsolete since 29.1)

Source Code

// Defined in /usr/src/emacs/src/editfns.c
{
  ptrdiff_t count, charpos = bol (n, &count);
  /* Return END constrained to the current input field.  */
  return Fconstrain_to_field (make_fixnum (charpos), make_fixnum (PT),
			      count != 0 ? Qt : Qnil,
			      Qt, Qnil);
}