original/man3/strchr.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Mon Apr 12 12:51:24 1993, David Metcalfe
  30 .\" 2006-05-19, Justin Pryzby <pryzbyj@justinpryzby.com>
  31 .\"     Document strchrnul(3).
  32 .\"
  33 .TH STRCHR 3  2014-01-20 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 strchr, strrchr, strchrnul \- locate character in string
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <string.h>
  39 .sp
  40 .BI "char *strchr(const char *" s ", int " c );
  41 .sp
  42 .BI "char *strrchr(const char *" s ", int " c );
  43 .sp
  44 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  45 .B #include <string.h>
  46 .sp
  47 .BI "char *strchrnul(const char *" s ", int " c );
  48 .fi
  49 .SH DESCRIPTION
  50 The
  51 .BR strchr ()
  52 function returns a pointer to the first occurrence
  53 of the character
  54 .I c
  55 in the string
  56 .IR s .
  57 .PP
  58 The
  59 .BR strrchr ()
  60 function returns a pointer to the last occurrence
  61 of the character
  62 .I c
  63 in the string
  64 .IR s .
  65 .PP
  66 The
  67 .BR strchrnul ()
  68 function is like
  69 .BR strchr ()
  70 except that if
  71 .I c
  72 is not found in
  73 .IR s ,
  74 then it returns a pointer to the null byte
  75 at the end of
  76 .IR s ,
  77 rather than NULL.
  78 .PP
  79 Here "character" means "byte"; these functions do not work with
  80 wide or multibyte characters.
  81 .SH RETURN VALUE
  82 The
  83 .BR strchr ()
  84 and
  85 .BR strrchr ()
  86 functions return a pointer to
  87 the matched character or NULL if the character is not found.
  88 The terminating null byte is considered part of the string,
  89 so that if
  90 .I c
  91 is specified as \(aq\\0\(aq,
  92 these functions return a pointer to the terminator.
  93
  94 The
  95 .BR strchrnul ()
  96 function returns a pointer to
  97 the matched character,
  98 or a pointer to the null
  99 byte at the end of
 100 .I s
 101 (i.e.,
 102 .IR "s+strlen(s)" )
 103 if the character is not found.
 104 .SH VERSIONS
 105 .BR strchrnul ()
 106 first appeared in glibc in version 2.1.1.
 107 .SH ATTRIBUTES
 108 .SS Multithreading (see pthreads(7))
 109 The
 110 .BR strchr (),
 111 .BR strrchr (),
 112 and
 113 .BR strchrnul ()
 114 functions are thread-safe.
 115 .SH CONFORMING TO
 116 .BR strchr ()
 117 and
 118 .BR strrchr ()
 119 are in SVr4, 4.3BSD, C89, C99.
 120 .BR strchrnul ()
 121 is a GNU extension.
 122 .SH SEE ALSO
 123 .BR index (3),
 124 .BR memchr (3),
 125 .BR rindex (3),
 126 .BR string (3),
 127 .BR strlen (3),
 128 .BR strpbrk (3),
 129 .BR strsep (3),
 130 .BR strspn (3),
 131 .BR strstr (3),
 132 .BR strtok (3),
 133 .BR wcschr (3),
 134 .BR wcsrchr (3)
 135 .SH COLOPHON
 136 This page is part of release 3.79 of the Linux
 137 .I man-pages
 138 project.
 139 A description of the project,
 140 information about reporting bugs,
 141 and the latest version of this page,
 142 can be found at
 143 \%http://www.kernel.org/doc/man\-pages/.