#4754: improve winsound documentation.

This commit is contained in:
Georg Brandl 2008-12-27 18:49:19 +00:00
parent 3eef441700
commit 348fa7968b
1 changed files with 7 additions and 2 deletions

View File

@ -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 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 *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 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, combination of the constants described below. If the *sound* parameter is
:exc:`RuntimeError` is raised. ``None``, any currently playing waveform sound is stopped. If the system
indicates an error, :exc:`RuntimeError` is raised.
.. function:: MessageBeep([type=MB_OK]) .. 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. Stop playing all instances of the specified sound.
.. note::
This flag is not supported on modern Windows platforms.
.. data:: SND_ASYNC .. data:: SND_ASYNC