X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_inwstr.3x;h=3b02feea86811436f90dc1e98d3330bb9ace1683;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=b3899c4b94f2eafbf53f35c91bf6828709e3bb1d;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x index b3899c4b..3b02feea 100644 --- a/man/curs_inwstr.3x +++ b/man/curs_inwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,58 +27,58 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inwstr.3x,v 1.14 2020/10/17 23:22:11 tom Exp $ +.\" $Id: curs_inwstr.3x,v 1.17 2022/02/12 20:05: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, -\fBwinwstr\fR, -\fBwinnwstr\fR, -\fBmvinwstr\fR, -\fBmvinnwstr\fR, -\fBmvwinwstr\fR, -\fBmvwinnwstr\fR \- get a string of \fBwchar_t\fR characters from a curses window +\fBinwstr\fP, +\fBinnwstr\fP, +\fBwinwstr\fP, +\fBwinnwstr\fP, +\fBmvinwstr\fP, +\fBmvinnwstr\fP, +\fBmvwinwstr\fP, +\fBmvwinnwstr\fP \- get a string of \fBwchar_t\fP characters from a curses window .SH SYNOPSIS .nf -\fB#include \fR +\fB#include \fP .sp -\fBint inwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB);\fR +\fBint inwstr(\fBwchar_t *\fIwstr\fB);\fR .br -\fBint innwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint innwstr(\fBwchar_t *\fIwstr\fB, int \fIn\fB);\fR .br -\fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR +\fBint winwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB);\fR .br -\fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint winnwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR .sp -\fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR +\fBint mvinwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\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 +\fBint mvinnwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR .br -\fBint mvwinwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR +\fBint mvwinwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB);\fR .br -\fBint mvwinnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint mvwinnwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR .fi .SH DESCRIPTION .PP -These routines return a string of \fBwchar_t\fR wide characters in \fIwstr\fR, +These routines return a string of \fBwchar_t\fP wide characters in \fIwstr\fP, 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 +The four functions with \fIn\fP as the last argument return +a leading substring at most \fIn\fP 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. +Transfer stops at the end of the current line, or when \fIn\fP characters have +been stored at the location referenced by \fIwstr\fP. .PP -If the size \fIn\fR is not large enough to store a complete complex character, +If the size \fIn\fP is not large enough to store a complete complex character, an error is generated. .SH NOTES .PP All routines except -\fBwinnwstr\fR +\fBwinnwstr\fP may be macros. .PP Each cell in the window holds a complex character (i.e., base- @@ -88,12 +88,12 @@ ignoring attributes and color. Use \fBin_wchstr\fP to return the complex characters from a window. .SH RETURN VALUE All routines return -\fBERR\fR +\fBERR\fP upon failure. Upon -successful completion, the *\fBinwstr\fR +successful completion, the *\fBinwstr\fP routines return -\fBOK\fR, and the *\fBinnwstr\fR +\fBOK\fP, and the *\fBinnwstr\fP routines return the number of characters read into the string. .PP @@ -101,6 +101,6 @@ 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 -\fBcurses\fR(3X), -\fBcurs_instr\fR(3X), -\fBcurs_in_wchstr\fR(3X) +\fBcurses\fP(3X), +\fBcurs_instr\fP(3X), +\fBcurs_in_wchstr\fP(3X)