summaryrefslogtreecommitdiff
path: root/handy.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-12-03 17:56:21 -0700
committerKarl Williamson <khw@cpan.org>2020-12-03 18:02:55 -0700
commitb96bd7bfd7bbd0ba78cbebd0f4437bef81209655 (patch)
treef2a64b5450e33e2abac2f8bcd350da6fa62c4fc2 /handy.h
parent153764ac87c44440fea60466e8f718671117bac2 (diff)
downloadperl-b96bd7bfd7bbd0ba78cbebd0f4437bef81209655.tar.gz
Fix and update documentation of memEQ, memNE, ...
This fixes GH #18379
Diffstat (limited to 'handy.h')
-rw-r--r--handy.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/handy.h b/handy.h
index 96f84fa5d1..360c383bc4 100644
--- a/handy.h
+++ b/handy.h
@@ -631,22 +631,24 @@ wrapper for C<strncmp>).
=for apidoc Am|bool|memEQ|char* s1|char* s2|STRLEN len
Test two buffers (which may contain embedded C<NUL> characters, to see if they
are equal. The C<len> parameter indicates the number of bytes to compare.
-Returns zero if equal, or non-zero if non-equal.
+Returns true or false. It is undefined behavior if either of the buffers
+doesn't contain at least C<len> bytes.
=for apidoc Am|bool|memEQs|char* s1|STRLEN l1|"s2"
Like L</memEQ>, but the second string is a literal enclosed in double quotes,
C<l1> gives the number of bytes in C<s1>.
-Returns zero if equal, or non-zero if non-equal.
+Returns true or false.
=for apidoc Am|bool|memNE|char* s1|char* s2|STRLEN len
Test two buffers (which may contain embedded C<NUL> characters, to see if they
are not equal. The C<len> parameter indicates the number of bytes to compare.
-Returns zero if non-equal, or non-zero if equal.
+Returns true or false. It is undefined behavior if either of the buffers
+doesn't contain at least C<len> bytes.
=for apidoc Am|bool|memNEs|char* s1|STRLEN l1|"s2"
Like L</memNE>, but the second string is a literal enclosed in double quotes,
C<l1> gives the number of bytes in C<s1>.
-Returns zero if non-equal, or zero if non-equal.
+Returns true or false.
=for apidoc Am|bool|memCHRs|"list"|char c
Returns the position of the first occurence of the byte C<c> in the literal