Home Explore Help
Sign In
downstream
/
ncurses
Watch 2
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
ncurses
/
doc
/
html
/
man
/
curs_in_wchstr.3x.html

curs_in_wchstr.3x.html 6.9 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
    2. 

  2. <!-- 
    3. 

  3.   ****************************************************************************
    4. 

  4.   * Copyright (c) 2002-2005,2006 Free Software Foundation, Inc.              *
    5. 

  5.   *                                                                          *
    6. 

  6.   * Permission is hereby granted, free of charge, to any person obtaining a  *
    7. 

  7.   * copy of this software and associated documentation files (the            *
    8. 

  8.   * "Software"), to deal in the Software without restriction, including      *
    9. 

  9.   * without limitation the rights to use, copy, modify, merge, publish,      *
    10. 

  10.   * distribute, distribute with modifications, sublicense, and/or sell       *
    11. 

  11.   * copies of the Software, and to permit persons to whom the Software is    *
    12. 

  12.   * furnished to do so, subject to the following conditions:                 *
    13. 

  13.   *                                                                          *
    14. 

  14.   * The above copyright notice and this permission notice shall be included  *
    15. 

  15.   * in all copies or substantial portions of the Software.                   *
    16. 

  16.   *                                                                          *
    17. 

  17.   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
    18. 

  18.   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
    19. 

  19.   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
    20. 

  20.   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
    21. 

  21.   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
    22. 

  22.   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
    23. 

  23.   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
    24. 

  24.   *                                                                          *
    25. 

  25.   * Except as contained in this notice, the name(s) of the above copyright   *
    26. 

  26.   * holders shall not be used in advertising or otherwise to promote the     *
    27. 

  27.   * sale, use or other dealings in this Software without prior written       *
    28. 

  28.   * authorization.                                                           *
    29. 

  29.   ****************************************************************************
    30. 

  30.   * @Id: curs_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp @
    31. 

  31. -->
    32. 

  32. <HTML>
    33. 

  33. <HEAD>
    34. 

  34. <TITLE>curs_in_wchstr 3x</TITLE>
    35. 

  35. <link rev=made href="mailto:bug-ncurses@gnu.org">
    36. 

  36. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    37. 

  37. </HEAD>
    38. 

  38. <BODY>
    39. 

  39. <H1>curs_in_wchstr 3x</H1>
    40. 

  40. <HR>
    41. 

  41. <PRE>
    42. 

  42. <!-- Manpage converted by man2html 3.0.1 -->
    43. 

  43. <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>                                   <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
    44. 

  44. 

  45. 

  46. 

  47. 

  48. </PRE>
    49. 

  49. <H2>NAME</H2><PRE>
    50. 

  50.        <STRONG>in_wchstr</STRONG>, <STRONG>in_wchnstr</STRONG>, <STRONG>win_wchstr</STRONG>, <STRONG>win_wchnstr</STRONG>,
    51. 

  51.        <STRONG>mvin_wchstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG> -
    52. 

  52.        get an array of complex characters and renditions from a
    53. 

  53.        curses window
    54. 

  54. 

  55. 

  56. </PRE>
    57. 

  57. <H2>SYNOPSIS</H2><PRE>
    58. 

  58.        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
    59. 

  59. 

  60.        <STRONG>int</STRONG> <STRONG>in_wchstr(cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
    61. 

  61.        <STRONG>int</STRONG> <STRONG>in_wchnstr(cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
    62. 

  62.        <STRONG>int</STRONG> <STRONG>win_wchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
    63. 

  63.        <STRONG>int</STRONG> <STRONG>win_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
    64. 

  64.        <STRONG>int</STRONG> <STRONG>mvin_wchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
    65. 

  65.        <STRONG>int</STRONG> <STRONG>mvin_wchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
    66. 

  66.        <STRONG>int</STRONG> <STRONG>mvwin_wchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG>
    67. 

  67.        <STRONG>int</STRONG> <STRONG>mvwin_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM>, int <EM>n</EM><STRONG>);</STRONG>
    68. 

  68. 

  69. 

  70. </PRE>
    71. 

  71. <H2>DESCRIPTION</H2><PRE>
    72. 

  72.        These functions return an array of complex  characters  in
    73. 

  73.        <EM>wchstr</EM>,  starting  at  the  current cursor position in the
    74. 

  74.        named window.  Attributes (rendition) are stored with  the
    75. 

  75.        characters.
    76. 

  76. 

  77.        The  <STRONG>in_wchnstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG> and <STRONG>win_wchn-</STRONG>
    78. 

  78.        <STRONG>str</STRONG> fill the array with at most <EM>n</EM> <STRONG>cchar_t</STRONG> elements.
    79. 

  79. 

  80. 

  81. </PRE>
    82. 

  82. <H2>NOTES</H2><PRE>
    83. 

  83.        Note that all routines except <STRONG>win_wchnstr</STRONG> may be macros.
    84. 

  84. 

  85.        Reading a line that overflows the array pointed to by <EM>wch-</EM>
    86. 

  86.        <EM>str</EM>  with <STRONG>in_wchstr</STRONG>, <STRONG>mvin_wchstr</STRONG>, <STRONG>mvwin_wchstr</STRONG> or <STRONG>win_wch-</STRONG>
    87. 

  87.        <STRONG>str</STRONG>  causes  undefined  results.  Therefore,  the  use  of
    88. 

  88.        <STRONG>in_wchnstr</STRONG>, <STRONG>mvin_wchnstr</STRONG>, <STRONG>mvwin_wchnstr</STRONG>, or <STRONG>win_wchnstr</STRONG> is
    89. 

  89.        recommended.
    90. 

  90. 

  91. 

  92. </PRE>
    93. 

  93. <H2>RETURN VALUES</H2><PRE>
    94. 

  94.        Upon successful completion,  these  functions  return  <STRONG>OK</STRONG>.
    95. 

  95.        Otherwise, they return <STRONG>ERR</STRONG>.
    96. 

  96. 

  97. 

  98. </PRE>
    99. 

  99. <H2>PORTABILITY</H2><PRE>
    100. 

  100.        The  XSI  Curses defines no error conditions.  This imple-
    101. 

  101.        mentation checks for null pointers, returning ERR in  that
    102. 

  102.        case.
    103. 

  103. 

  104. 

  105. </PRE>
    106. 

  106. <H2>SEE ALSO</H2><PRE>
    107. 

  107.        Functions:  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>,  <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>,
    108. 

  108.        <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
    109. 

  109. 

  110. 

  111. 

  112.                                                      <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
    113. 

  113. </PRE>
    114. 

  114. <HR>
    115. 

  115. <ADDRESS>
    116. 

  116. Man(1) output converted with
    117. 

  117. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
    118. 

  118. </ADDRESS>
    119. 

  119. </BODY>
    120. 

  120. </HTML>
    121. 

  121.