manual/LDP_man-pages/original/man3/wcsstr.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH WCSSTR 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wcsstr \- locate a substring in a wide-character string
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .sp
  21 .BI "wchar_t *wcsstr(const wchar_t *" haystack ", const wchar_t *" needle );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR wcsstr ()
  26 function is the wide-character equivalent of the
  27 .BR strstr (3)
  28 function.
  29 It searches for the first occurrence of the wide-character string
  30 \fIneedle\fP (without its terminating L\(aq\\0\(aq character) as a substring in
  31 the wide-character string \fIhaystack\fP.
  32 .SH "RETURN VALUE"
  33 The
  34 .BR wcsstr ()
  35 function returns a pointer to the first occurrence of
  36 \fIneedle\fP in \fIhaystack\fP.
  37 It returns NULL if \fIneedle\fP does not occur
  38 as a substring in \fIhaystack\fP.
  39 .PP
  40 Note the special case:
  41 If \fIneedle\fP is the empty wide-character string,
  42 the return value is always \fIhaystack\fP itself.
  43 .SH "CONFORMING TO"
  44 C99.
  45 .SH "SEE ALSO"
  46 .BR strstr (3),
  47 .BR wcschr (3)