Add description of strchrnul().

This commit is contained in:
Michael Kerrisk 2006-05-18 23:06:18 +00:00
parent 2df47dc8f1
commit e9d27e13de
1 changed files with 18 additions and 1 deletions

View File

@ -27,7 +27,7 @@
.\" Modified Mon Apr 12 12:51:24 1993, David Metcalfe
.TH STRCHR 3 1993-04-12 "" "Linux Programmer's Manual"
.SH NAME
strchr, strrchr \- locate character in string
strchr, strrchr, strchrnul \- locate character in string
.SH SYNOPSIS
.nf
.B #include <string.h>
@ -35,6 +35,11 @@ strchr, strrchr \- locate character in string
.BI "char *strchr(const char *" s ", int " c );
.sp
.BI "char *strrchr(const char *" s ", int " c );
.sp
.B #define _GNU_SOURCE
.B #include <string.h>
.sp
.BI "char *strrchr(const char *" s ", int " c );
.fi
.SH DESCRIPTION
The \fBstrchr\fP() function returns a pointer to the first occurrence
@ -43,17 +48,29 @@ of the character \fIc\fP in the string \fIs\fP.
The \fBstrrchr\fP() function returns a pointer to the last occurrence
of the character \fIc\fP in the string \fIs\fP.
.PP
The \fBstrchrnul\fP() function is like \fBstrchr\fP()
except that if \fIc\fP is not found in \fIs\fP,
then it returns a pointer to the null byte
at the end of \fIs\fP, rather than NULL.
.PP
Here "character" means "byte"; these functions do not work with
wide or multi-byte characters.
.SH "RETURN VALUE"
The \fBstrchr\fP() and \fBstrrchr\fP() functions return a pointer to
the matched character or NULL if the character is not found.
The \fBstrchrnul\fP() function returns a pointer to
the matched character,
or a pointer to the null
byte at the end of \fIs\fP (i.e., \fIs+strlen(s)\fP)
if the character is not found.
.SH "CONFORMING TO"
SVID 3, POSIX, 4.3BSD, ISO 9899
.SH "SEE ALSO"
.BR index (3),
.BR memchr (3),
.BR rindex (3),
.BR strlen (3),
.BR strpbrk (3),
.BR strsep (3),
.BR strspn (3),