[Python-checkins] python/dist/src/Doc/lib libwinsound.tex,1.12,1.13
gvanrossum@users.sourceforge.net
gvanrossum@users.sourceforge.net
Thu, 15 May 2003 18:42:24 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv7705
Modified Files:
libwinsound.tex
Log Message:
Add docs for MessageBeep.
Index: libwinsound.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libwinsound.tex,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** libwinsound.tex 20 Oct 2001 04:24:09 -0000 1.12
--- libwinsound.tex 16 May 2003 01:42:22 -0000 1.13
***************
*** 38,41 ****
--- 38,51 ----
\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}
***************
*** 110,112 ****
--- 120,142 ----
\begin{datadesc}{SND_NOWAIT}
Return immediately if the sound driver is busy.
+ \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}