man3/wcsstr.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH WCSSTR 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wcsstr \- locate a substring in a wide-character string
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .PP
  23 .BI "wchar_t *wcsstr(const wchar_t *" haystack ", const wchar_t *" needle );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR wcsstr ()
  28 function is the wide-character equivalent of the
  29 .BR strstr (3)
  30 function.
  31 It searches for the first occurrence of the wide-character string
  32 .I needle
  33 (without its terminating null wide character (L\(aq\e0\(aq))
  34 as a substring in the wide-character string
  35 .IR haystack .
  36 .SH RETURN VALUE
  37 The
  38 .BR wcsstr ()
  39 function returns a pointer to the first occurrence of
  40 .I needle
  41 in
  42 .IR haystack .
  43 It returns NULL if
  44 .I needle
  45 does not occur
  46 as a substring in
  47 .IR haystack .
  48 .PP
  49 Note the special case:
  50 If
  51 .I needle
  52 is the empty wide-character string,
  53 the return value is always
  54 .I haystack
  55 itself.
  56 .SH ATTRIBUTES
  57 For an explanation of the terms used in this section, see
  58 .BR attributes (7).
  59 .ad l
  60 .nh
  61 .TS
  62 allbox;
  63 lbx lb lb
  64 l l l.
  65 Interface       Attribute       Value
  66 T{
  67 .BR wcsstr ()
  68 T}      Thread safety   MT-Safe
  69 .TE
  70 .hy
  71 .ad
  72 .sp 1
  73 .SH CONFORMING TO
  74 POSIX.1-2001, POSIX.1-2008, C99.
  75 .SH SEE ALSO
  76 .BR strstr (3),
  77 .BR wcschr (3)