Function: org-agenda-skip-entry-when-regexp-matches-in-subtree

org-agenda-skip-entry-when-regexp-matches-in-subtree is a byte-compiled function defined in org-compat.el.gz.

This function is obsolete since 9.1; use org-agenda-skip-if instead.

Signature

(org-agenda-skip-entry-when-regexp-matches-in-subtree)

Documentation

Check if the current subtree contains match for org-agenda-skip-regexp.

If yes, it returns the end position of the current entry (NOT the tree), causing agenda commands to skip the entry but continuing the search in the subtree. This is a function that can be put into org-agenda-skip-function for the duration of a command. An important use of this function is for the stuck project list.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-compat.el.gz
(defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  "Check if the current subtree contains match for `org-agenda-skip-regexp'.
If yes, it returns the end position of the current entry (NOT the tree),
causing agenda commands to skip the entry but continuing the search in
the subtree.  This is a function that can be put into
`org-agenda-skip-function' for the duration of a command.  An important
use of this function is for the stuck project list."
  (declare (obsolete "use `org-agenda-skip-if' instead." "9.1"))
  (let ((end (save-excursion (org-end-of-subtree t)))
	(entry-end (save-excursion (outline-next-heading) (1- (point))))
	skip)
    (save-excursion
      (setq skip (re-search-forward org-agenda-skip-regexp end t)))
    (and skip entry-end)))