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

org-agenda-skip-subtree-when-regexp-matches 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-subtree-when-regexp-matches)

Documentation

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

If yes, it returns the end position of this tree, causing agenda commands to skip this subtree. This is a function that can be put into org-agenda-skip-function for the duration of a command.

Source Code

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