X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inwstr.3x;h=b3899c4b94f2eafbf53f35c91bf6828709e3bb1d;hp=63ebed0bec832a195b8fd0d74f088daa76361cdb;hb=152c5a605234b7ea36ba3a03ec07e124bb6aac75;hpb=b5be26931d6488adcb1ff8bc07df9de378ce0d27 diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x index 63ebed0b..b3899c4b 100644 --- a/man/curs_inwstr.3x +++ b/man/curs_inwstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2012,2017 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,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inwstr.3x,v 1.9 2017/10/28 23:42:58 tom Exp $ +.\" $Id: curs_inwstr.3x,v 1.14 2020/10/17 23:22:11 tom Exp $ .TH curs_inwstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME \fBinwstr\fR, \fBinnwstr\fR, @@ -48,7 +53,7 @@ \fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR .br \fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR -.br +.sp \fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR .br \fBint mvinnwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR @@ -62,8 +67,9 @@ These routines return a string of \fBwchar_t\fR wide characters in \fIwstr\fR, extracted starting at the current cursor position in the named window. .PP -The four functions with \fIn\fR as the last argument return a leading substring at most -\fIn\fR characters long (exclusive of the trailing NUL). +The four functions with \fIn\fR as the last argument return +a leading substring at most \fIn\fR characters long +(exclusive of the trailing NUL). Transfer stops at the end of the current line, or when \fIn\fR characters have been stored at the location referenced by \fIwstr\fR. .PP @@ -83,14 +89,15 @@ Use \fBin_wchstr\fP to return the complex characters from a window. .SH RETURN VALUE All routines return \fBERR\fR -upon failure. Upon +upon failure. +Upon successful completion, the *\fBinwstr\fR routines return \fBOK\fR, and the *\fBinnwstr\fR routines return the number of characters read into the string. .PP -Functions with a "mv" prefix first perform a cursor movement using +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 SEE ALSO