summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwtc%netscape.com <devnull@localhost>2000-06-10 00:43:59 +0000
committerwtc%netscape.com <devnull@localhost>2000-06-10 00:43:59 +0000
commit3961559c5e3cebd4f83d6418eceaa1be0ab26eff (patch)
treea4a1339ffcbca6a1df557bbb9973ba02bd45b06c
parent86ee95c6d1447c74b41b24f03418dc097fe97ae1 (diff)
downloadnspr-hg-3961559c5e3cebd4f83d6418eceaa1be0ab26eff.tar.gz
Bugzilla bug #17806: improved comments for PR_Poll.
-rw-r--r--pr/include/prio.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/pr/include/prio.h b/pr/include/prio.h
index 597e417f..edfd458e 100644
--- a/pr/include/prio.h
+++ b/pr/include/prio.h
@@ -1870,7 +1870,10 @@ struct PRPollDesc {
** PRPollDesc.in_flags should be set to the desired request
** (read/write/except or some combination). Upon successful return from
** this call PRPollDesc.out_flags will be set to indicate what kind of
-** i/o can be performed on the respective descriptor.
+** i/o can be performed on the respective descriptor. PR_Poll() uses the
+** out_flags fields as scratch variables during the call. If PR_Poll()
+** returns 0 or -1, the out_flags fields do not contain meaningful values
+** and must not be used.
**
** INPUTS:
** PRPollDesc *pds A pointer to an array of PRPollDesc
@@ -1889,11 +1892,7 @@ struct PRPollDesc {
** PRInt32 Number of PRPollDesc's with events or zero
** if the function timed out or -1 on failure.
** The reason for the failure is obtained by
-** calling PR_GetError(). PR_Poll() uses the
-** out_flags fields as scratch variables
-** during the call. If PR_Poll() returns 0
-** or -1, the out_flags fields do not contain
-** meaningful values and must not be used.
+** calling PR_GetError().
**************************************************************************
*/
NSPR_API(PRInt32) PR_Poll(