Function: point-at-bol

point-at-bol is a for line-beginning-position, defined in editfns.c.

Signature

(point-at-bol &optional N)

Documentation

Return the character position of the first character on the current line.

With optional argument N, scan forward N - 1 lines first. If the scan reaches the end of the buffer, return that position.

This function ignores text display directionality; it returns the position of the first character in logical order, i.e. the smallest character position on the logical line. See vertical-motion for movement by screen lines.

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.

Aliases

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