wmemchr.3p (2731B)
- '\" et
- .TH WMEMCHR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
- .\"
- .SH PROLOG
- This manual page is part of the POSIX Programmer's Manual.
- The Linux implementation of this interface may differ (consult
- the corresponding Linux manual page for details of Linux behavior),
- or the interface may not be implemented on Linux.
- .\"
- .SH NAME
- wmemchr
- \(em find a wide character in memory
- .SH SYNOPSIS
- .LP
- .nf
- #include <wchar.h>
- .P
- wchar_t *wmemchr(const wchar_t *\fIws\fP, wchar_t \fIwc\fP, size_t \fIn\fP);
- .fi
- .SH DESCRIPTION
- The functionality described on this reference page is aligned with the
- ISO\ C standard. Any conflict between the requirements described here and the
- ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
- .P
- The
- \fIwmemchr\fR()
- function shall locate the first occurrence of
- .IR wc
- in the initial
- .IR n
- wide characters of the object pointed to by
- .IR ws .
- This function shall not be affected by locale and all
- .BR wchar_t
- values shall be treated identically. The null wide character and
- .BR wchar_t
- values not corresponding to valid characters shall not be treated
- specially.
- .P
- If
- .IR n
- is zero, the application shall ensure that
- .IR ws
- is a valid pointer and the function behaves as if no valid
- occurrence of
- .IR wc
- is found.
- .SH "RETURN VALUE"
- The
- \fIwmemchr\fR()
- function shall return a pointer to the located wide character, or a null
- pointer if the wide character does not occur in the object.
- .SH ERRORS
- No errors are defined.
- .LP
- .IR "The following sections are informative."
- .SH EXAMPLES
- None.
- .SH "APPLICATION USAGE"
- None.
- .SH RATIONALE
- None.
- .SH "FUTURE DIRECTIONS"
- None.
- .SH "SEE ALSO"
- .IR "\fIwmemcmp\fR\^(\|)",
- .IR "\fIwmemcpy\fR\^(\|)",
- .IR "\fIwmemmove\fR\^(\|)",
- .IR "\fIwmemset\fR\^(\|)"
- .P
- The Base Definitions volume of POSIX.1\(hy2017,
- .IR "\fB<wchar.h>\fP"
- .\"
- .SH COPYRIGHT
- Portions of this text are reprinted and reproduced in electronic form
- from IEEE Std 1003.1-2017, Standard for Information Technology
- -- Portable Operating System Interface (POSIX), The Open Group Base
- Specifications Issue 7, 2018 Edition,
- Copyright (C) 2018 by the Institute of
- Electrical and Electronics Engineers, Inc and The Open Group.
- In the event of any discrepancy between this version and the original IEEE and
- The Open Group Standard, the original IEEE and The Open Group Standard
- is the referee document. The original Standard can be obtained online at
- http://www.opengroup.org/unix/online.html .
- .PP
- Any typographical or formatting errors that appear
- in this page are most likely
- to have been introduced during the conversion of the source files to
- man page format. To report such errors, see
- https://www.kernel.org/doc/man-pages/reporting_bugs.html .