Bug 431982: Improved the comment for PR_FileDesc2NativeHandle. r=nelson.

This commit is contained in:
wtc%google.com 2008-05-04 01:39:30 +00:00
Родитель 73c691b462
Коммит 3f3daeda95
1 изменённых файлов: 14 добавлений и 2 удалений

Просмотреть файл

@ -65,8 +65,20 @@ NSPR_API(const PRIOMethods*) PR_GetUDPMethods(void);
NSPR_API(const PRIOMethods*) PR_GetPipeMethods(void);
/*
** Convert a NSPR Socket Handle to a Native Socket handle.
** This function will be obsoleted with the next release; avoid using it.
** Convert a NSPR socket handle to a native socket handle.
**
** Using this function makes your code depend on the properties of the
** current NSPR implementation, which may change (although extremely
** unlikely because of NSPR's backward compatibility requirement). Avoid
** using it if you can.
**
** If you use this function, you need to understand what NSPR does to
** the native handle. For example, NSPR puts native socket handles in
** non-blocking mode or associates them with an I/O completion port (the
** WINNT build configuration only). Your use of the native handle should
** not interfere with NSPR's use of the native handle. If your code
** changes the configuration of the native handle, (e.g., changes it to
** blocking or closes it), NSPR will not work correctly.
*/
NSPR_API(PROsfd) PR_FileDesc2NativeHandle(PRFileDesc *);
NSPR_API(void) PR_ChangeFileDescNativeHandle(PRFileDesc *, PROsfd);