diff options
| author | Georg Brandl <georg@python.org> | 2008-12-27 18:49:19 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2008-12-27 18:49:19 (GMT) |
| commit | 348fa7968ba8aa972bf418f1528f9d089f892f34 (patch) | |
| tree | 625dccdb6ae73dce3310425ce6cd63d0ff8043da /Doc/library | |
| parent | 3eef44170013ca49e204a3a5fd1408adfaf49e0c (diff) | |
| download | cpython-348fa7968ba8aa972bf418f1528f9d089f892f34.zip cpython-348fa7968ba8aa972bf418f1528f9d089f892f34.tar.gz cpython-348fa7968ba8aa972bf418f1528f9d089f892f34.tar.bz2 | |
#4754: improve winsound documentation.
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/winsound.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/library/winsound.rst b/Doc/library/winsound.rst index f9709fe..b4a3391 100644 --- a/Doc/library/winsound.rst +++ b/Doc/library/winsound.rst @@ -30,8 +30,9 @@ provided by Windows platforms. It includes functions and several constants. Call the underlying :cfunc:`PlaySound` function from the Platform API. The *sound* parameter may be a filename, audio data as a string, or ``None``. Its interpretation depends on the value of *flags*, which can be a bitwise ORed - combination of the constants described below. If the system indicates an error, - :exc:`RuntimeError` is raised. + combination of the constants described below. If the *sound* parameter is + ``None``, any currently playing waveform sound is stopped. If the system + indicates an error, :exc:`RuntimeError` is raised. .. function:: MessageBeep([type=MB_OK]) @@ -108,6 +109,10 @@ provided by Windows platforms. It includes functions and several constants. Stop playing all instances of the specified sound. + .. note:: + + This flag is not supported on modern Windows platforms. + .. data:: SND_ASYNC |