Skip to content

Commit f25f128

Browse files
authored
Add docs for yr_scanner_last_error_rule() and yr_scanner_last_error_string(). (VirusTotal#1449)
1 parent b01d9ae commit f25f128

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/capi.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -895,7 +895,7 @@ Functions
895895
896896
.. versionadded:: 3.8.0
897897
898-
Scan a serie of memory blocks that are provided by a :c:type:`YR_MEMORY_BLOCK_ITERATOR`.
898+
Scan a series of memory blocks that are provided by a :c:type:`YR_MEMORY_BLOCK_ITERATOR`.
899899
The iterator has a pair of `first` and `next` functions, that must return
900900
the first and next blocks respectively. If the iterator returns :c:macro:`ERROR_BLOCK_NOT_READY`
901901
from `first` or `next`, `yr_scanner_scan_mem_blocks` also returns :c:macro:`ERROR_BLOCK_NOT_READY`,
@@ -978,6 +978,19 @@ Functions
978978
979979
:c:macro:`ERROR_TOO_MANY_MATCHES`
980980
981+
.. c:function:: YR_RULE* yr_scanner_last_error_rule(YR_SCANNER* scanner)
982+
983+
.. versionadded:: 3.8.0
984+
985+
Return a pointer to the ``YR_RULE`` which triggered a scanning error. In the
986+
case where the rule is unable to be determined, NULL is returned.
987+
988+
.. c:function:: YR_RULE* yr_scanner_last_error_string(YR_SCANNER* scanner)
989+
990+
.. versionadded:: 3.8.0
991+
992+
Return a pointer to the ``YR_STRING`` which triggered a scanning error.
993+
981994
Error codes
982995
-----------
983996

0 commit comments

Comments
 (0)