summaryrefslogtreecommitdiffstats
path: root/Doc/library/msvcrt.rst
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2007-12-10 15:12:41 (GMT)
committerChristian Heimes <christian@cheimes.de>2007-12-10 15:12:41 (GMT)
commit7c7f6afa928c24221f8463a1aa71fc6ef532d29e (patch)
tree8def7775fe40f5b218b9c3cae34527cc714e7ec6 /Doc/library/msvcrt.rst
parente6daafb449c57f3fafd11c2513f96bf6f6ca130e (diff)
downloadcpython-7c7f6afa928c24221f8463a1aa71fc6ef532d29e.zip
cpython-7c7f6afa928c24221f8463a1aa71fc6ef532d29e.tar.gz
cpython-7c7f6afa928c24221f8463a1aa71fc6ef532d29e.tar.bz2
Added wide char api variants of getch and putch to msvcrt module. The wide char methods are required to fix #1578 in py3k. I figured out that they might be useful in 2.6, too.
Diffstat (limited to 'Doc/library/msvcrt.rst')
-rw-r--r--Doc/library/msvcrt.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/Doc/library/msvcrt.rst b/Doc/library/msvcrt.rst
index d43bb4c..9fa49da 100644
--- a/Doc/library/msvcrt.rst
+++ b/Doc/library/msvcrt.rst
@@ -16,6 +16,10 @@ this in the implementation of the :func:`getpass` function.
Further documentation on these functions can be found in the Platform API
documentation.
+The module implements both the normal and wide char variants of the console I/O
+api. The normal API deals only with ASCII characters and is of limited use
+for internationalized applications. The wide char API should be used where
+ever possible
.. _msvcrt-files:
@@ -94,6 +98,13 @@ Console I/O
return the keycode. The :kbd:`Control-C` keypress cannot be read with this
function.
+
+.. function:: getwch()
+
+ Wide char variant of `func:getch`, returns unicode.
+
+ ..versionadded:: 2.6
+
.. function:: getche()
@@ -101,16 +112,37 @@ Console I/O
printable character.
+.. function:: getwche()
+
+ Wide char variant of `func:getche`, returns unicode.
+
+ ..versionadded:: 2.6
+
+
.. function:: putch(char)
Print the character *char* to the console without buffering.
+
+.. function:: putwch(unicode_char)
+
+ Wide char variant of `func:putch`, accepts unicode.
+
+ ..versionadded:: 2.6
+
.. function:: ungetch(char)
Cause the character *char* to be "pushed back" into the console buffer; it will
be the next character read by :func:`getch` or :func:`getche`.
+
+.. function:: ungetwch(unicode_char)
+
+ Wide char variant of `func:ungetch`, accepts unicode.
+
+ ..versionadded:: 2.6
+
.. _msvcrt-other: