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  2021-03-22 "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 .PP
  40 .BI "char *strsep(char **restrict " stringp ", const char *restrict " delim );
  41 .fi
  42 .PP
  43 .RS -4
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .RE
  47 .PP
  48 .BR strsep ():
  49 .nf
  50     Since glibc 2.19:
  51         _DEFAULT_SOURCE
  52     Glibc 2.19 and earlier:
  53         _BSD_SOURCE
  54 .fi
  55 .SH DESCRIPTION
  56 If
  57 .I *stringp
  58 is NULL, the
  59 .BR strsep ()
  60 function returns NULL
  61 and does nothing else.
  62 Otherwise, this function finds the first token
  63 in the string
  64 .IR *stringp ,
  65 that is delimited by one of the bytes in the string
  66 .IR delim .
  67 This token is terminated by overwriting the delimiter
  68 with a null byte (\(aq\e0\(aq),
  69 and
  70 .I *stringp
  71 is updated to point past the token.
  72 In case no delimiter was found, the token is taken to be
  73 the entire string
  74 .IR *stringp ,
  75 and
  76 .I *stringp
  77 is made NULL.
  78 .SH RETURN VALUE
  79 The
  80 .BR strsep ()
  81 function returns a pointer to the token,
  82 that is, it returns the original value of
  83 .IR *stringp .
  84 .SH ATTRIBUTES
  85 For an explanation of the terms used in this section, see
  86 .BR attributes (7).
  87 .ad l
  88 .nh
  89 .TS
  90 allbox;
  91 lbx lb lb
  92 l l l.
  93 Interface       Attribute       Value
  94 T{
  95 .BR strsep ()
  96 T}      Thread safety   MT-Safe
  97 .TE
  98 .hy
  99 .ad
 100 .sp 1
 101 .SH CONFORMING TO
 102 4.4BSD.
 103 .SH NOTES
 104 The
 105 .BR strsep ()
 106 function was introduced as a replacement for
 107 .BR strtok (3),
 108 since the latter cannot handle empty fields.
 109 However,
 110 .BR strtok (3)
 111 conforms to C89/C99 and hence is more portable.
 112 .SH BUGS
 113 Be cautious when using this function.
 114 If you do use it, note that:
 115 .IP * 2
 116 This function modifies its first argument.
 117 .IP *
 118 This function cannot be used on constant strings.
 119 .IP *
 120 The identity of the delimiting character is lost.
 121 .SH SEE ALSO
 122 .BR index (3),
 123 .BR memchr (3),
 124 .BR rindex (3),
 125 .BR strchr (3),
 126 .BR string (3),
 127 .BR strpbrk (3),
 128 .BR strspn (3),
 129 .BR strstr (3),
 130 .BR strtok (3)