man3/wcsstr.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_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  2011-09-28 "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 .sp
  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 \fIneedle\fP (without its terminating null wide character (L\(aq\\0\(aq))
  33 as a substring in the wide-character string \fIhaystack\fP.
  34 .SH RETURN VALUE
  35 The
  36 .BR wcsstr ()
  37 function returns a pointer to the first occurrence of
  38 \fIneedle\fP in \fIhaystack\fP.
  39 It returns NULL if \fIneedle\fP does not occur
  40 as a substring in \fIhaystack\fP.
  41 .PP
  42 Note the special case:
  43 If \fIneedle\fP is the empty wide-character string,
  44 the return value is always \fIhaystack\fP itself.
  45 .SH CONFORMING TO
  46 C99.
  47 .SH SEE ALSO
  48 .BR strstr (3),
  49 .BR wcschr (3)