X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wchstr.3x;h=4feae48098ca2405274e80f063bc2bcd77586be4;hp=0012789f70fbda03f12bb88cc25a9de11c6dfe7e;hb=42259b594b5dabd37fe2bc294051d2db82e873a2;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;ds=sidebyside diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x index 0012789f..4feae480 100644 --- a/man/curs_in_wchstr.3x +++ b/man/curs_in_wchstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,8 +27,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wchstr.3x,v 1.2 2002/05/18 21:48:30 tom Exp $ +.\" $Id: curs_in_wchstr.3x,v 1.14 2020/10/17 23:19:44 tom Exp $ .TH curs_in_wchstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.na +.hy 0 .SH NAME \fBin_wchstr\fR, \fBin_wchnstr\fR, @@ -37,10 +44,12 @@ \fBmvin_wchnstr\fR, \fBmvwin_wchstr\fR, \fBmvwin_wchnstr\fR \- get an array of complex characters and renditions from a curses window +.ad +.hy .SH SYNOPSIS .nf \fB#include \fR - +.sp \fBint in_wchstr(cchar_t *\fR\fIwchstr\fR\fB);\fR .br \fBint in_wchnstr(cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR @@ -48,7 +57,7 @@ \fBint win_wchstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR .br \fBint win_wchnstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR -.br +.sp \fBint mvin_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR .br \fBint mvin_wchnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR @@ -88,30 +97,30 @@ with \fBmvwin_wchstr\fR or \fBwin_wchstr\fR -causes undefined results. Therefore, the use of +causes undefined results. +Therefore, the use of \fBin_wchnstr\fR, \fBmvin_wchnstr\fR, \fBmvwin_wchnstr\fR, or \fBwin_wchnstr\fR is recommended. -.SH RETURN VALUES +.SH RETURN VALUE Upon successful completion, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.PP +Functions with a \*(``mv\*('' prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY The XSI Curses defines no error conditions. This implementation checks for null pointers, -returning ERR in that case. +returning \fBERR\fP in that case. .SH SEE ALSO Functions: \fBcurses\fR(3X), -\fBcurs_in_wch\fR(3X) +\fBcurs_in_wch\fR(3X), \fBcurs_instr\fR(3X), \fBcurs_inwstr\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurs_inchstr\fR(3X)