mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-02-10 17:24:29 +00:00
14e205a735
Depends on D137612 Differential Revision: https://phabricator.services.mozilla.com/D137650
41 lines
671 B
ReStructuredText
41 lines
671 B
ReStructuredText
PR_Close
|
|
========
|
|
|
|
Closes a file descriptor.
|
|
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. code:: eval
|
|
|
|
#include <prio.h>
|
|
|
|
PRStatus PR_Close(PRFileDesc *fd);
|
|
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
The function has the following parameters:
|
|
|
|
``fd``
|
|
A pointer to a :ref:`PRFileDesc` object.
|
|
|
|
|
|
Returns
|
|
~~~~~~~
|
|
|
|
One of the following values:
|
|
|
|
- If file descriptor is closed successfully, ``PR_SUCCESS``.
|
|
- If the file descriptor is not closed successfully, ``PR_FAILURE``.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
The file descriptor may represent a normal file, a socket, or an end
|
|
point of a pipe. On successful return, :ref:`PR_Close` frees the dynamic
|
|
memory and other resources identified by the ``fd`` parameter.
|