Update of /cvsroot/pywin32/pywin32/win32/src
In directory sc8-pr-cvs1:/tmp/cvs-serv28343/src
Modified Files:
win32file.i
Log Message:
Fix WaitCommEvent docs.
Index: win32file.i
===================================================================
RCS file: /cvsroot/pywin32/pywin32/win32/src/win32file.i,v
retrieving revision 1.31
retrieving revision 1.32
diff -C2 -d -r1.31 -r1.32
*** win32file.i 10 Mar 2003 01:05:38 -0000 1.31
--- win32file.i 1 Sep 2003 08:11:08 -0000 1.32
***************
*** 2287,2290 ****
--- 2287,2291 ----
%{
+ // @pyswig |WaitCommEvent|Waits for an event to occur for a specified communications device. The set of events that are monitored by this function is contained in the event mask associated with the device handle.
static PyObject *MyWaitCommEvent(PyObject *self, PyObject *args)
{
***************
*** 2318,2321 ****
--- 2319,2326 ----
return PyWin_SetAPIError("WaitCommError", rc);
return Py_BuildValue("ll", rc, *pmask);
+ // @rdesc The result is a tuple of (rc, mask_val), where rc is zero for success, or
+ // the result of calling GetLastError() otherwise. The mask_val is the new mask value
+ // once the function has returned, but if an Overlapped object is passed, this value
+ // will generally be meaningless. See the comments for more details.
// @comm If an overlapped structure is passed, then the <om PyOVERLAPPED.dword>
// address is passed to the Win32 API as the mask. This means that once the
|
