original/man3/strsep.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 Sat Jul 24 18:00:10 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Mon Jan 20 12:04:18 1997 by Andries Brouwer (aeb@cwi.nl)
  31 .\" Modified Tue Jan 23 20:23:07 2001 by Andries Brouwer (aeb@cwi.nl)
  32 .\"
  33 .TH STRSEP 3  2014-02-25 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 strsep \- extract token from string
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <string.h>
  39 .sp
  40 .BI "char *strsep(char **" stringp ", const char *" delim );
  41 .fi
  42 .sp
  43 .in -4n
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .in
  47 .sp
  48 .BR strsep ():
  49 _BSD_SOURCE
  50 .SH DESCRIPTION
  51 If
  52 .I *stringp
  53 is NULL, the
  54 .BR strsep ()
  55 function returns NULL
  56 and does nothing else.
  57 Otherwise, this function finds the first token
  58 in the string
  59 .IR *stringp ,
  60 that is delimited by one of the bytes in the string
  61 .IR delim .
  62 This token is terminated by overwriting the delimiter
  63 with a null byte (\(aq\\0\(aq),
  64 and
  65 .I *stringp
  66 is updated to point past the token.
  67 In case no delimiter was found, the token is taken to be
  68 the entire string
  69 .IR *stringp ,
  70 and
  71 .I *stringp
  72 is made NULL.
  73 .SH RETURN VALUE
  74 The
  75 .BR strsep ()
  76 function returns a pointer to the token,
  77 that is, it returns the original value of
  78 .IR *stringp .
  79 .SH ATTRIBUTES
  80 .SS Multithreading (see pthreads(7))
  81 The
  82 .BR strsep ()
  83 function is thread-safe.
  84 .SH CONFORMING TO
  85 4.4BSD.
  86 .SH NOTES
  87 The
  88 .BR strsep ()
  89 function was introduced as a replacement for
  90 .BR strtok (3),
  91 since the latter cannot handle empty fields.
  92 However,
  93 .BR strtok (3)
  94 conforms to C89/C99 and hence is more portable.
  95 .SH BUGS
  96 Be cautious when using this function.
  97 If you do use it, note that:
  98 .IP * 2
  99 This function modifies its first argument.
 100 .IP *
 101 This function cannot be used on constant strings.
 102 .IP *
 103 The identity of the delimiting character is lost.
 104 .SH SEE ALSO
 105 .BR index (3),
 106 .BR memchr (3),
 107 .BR rindex (3),
 108 .BR strchr (3),
 109 .BR string (3),
 110 .BR strpbrk (3),
 111 .BR strspn (3),
 112 .BR strstr (3),
 113 .BR strtok (3)
 114 .SH COLOPHON
 115 This page is part of release 3.79 of the Linux
 116 .I man-pages
 117 project.
 118 A description of the project,
 119 information about reporting bugs,
 120 and the latest version of this page,
 121 can be found at
 122 \%http://www.kernel.org/doc/man\-pages/.