traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add docs for MessageBeep.

This commit is contained in:
Guido van Rossum 2003-05-16 01:42:22 +00:00
parent 993bc3a708
commit 8f512a22cd
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Doc/lib/libwinsound.tex
View File

@ -37,6 +37,16 @@ two functions and several constants.
\exception{RuntimeError} is raised. \exception{RuntimeError} is raised.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{MessageBeep}{\optional{type=\code{MB_OK}}}
Call the underlying \cfunction{MessageBeep()} function from the
Platform API. This plays a sound as specified in the registry. The
\var{type} argument specifies which sound to play; possible values
are \code{-1}, \code{MB_ICONASTERISK}, \code{MB_ICONEXCLAMATION},
\code{MB_ICONHAND}, \code{MB_ICONQUESTION}, and \code{MB_OK}, all
described below. The value \code{-1} produces a ``simple beep'';
this is the final fallback if a sound cannot be played otherwise.
\versionadded{2.3}
\end{funcdesc}
\begin{datadesc}{SND_FILENAME} \begin{datadesc}{SND_FILENAME}
The \var{sound} parameter is the name of a WAV file. The \var{sound} parameter is the name of a WAV file.
@ -110,3 +120,23 @@ winsound.PlaySound("*", winsound.SND_ALIAS)
\begin{datadesc}{SND_NOWAIT} \begin{datadesc}{SND_NOWAIT}
Return immediately if the sound driver is busy. Return immediately if the sound driver is busy.
\end{datadesc} \end{datadesc}
\begin{datadesc}{MB_ICONASTERISK}
Play the \code{SystemDefault} sound.
\end{datadesc}
\begin{datadesc}{MB_ICONEXCLAMATION}
Play the \code{SystemExclamation} sound.
\end{datadesc}
\begin{datadesc}{MB_ICONHAND}
Play the \code{SystemHand} sound.
\end{datadesc}
\begin{datadesc}{MB_ICONQUESTION}
Play the \code{SystemQuestion} sound.
\end{datadesc}
\begin{datadesc}{MB_OK}
Play the \code{SystemDefault} sound.
\end{datadesc}