PR_Delete

  • Revision slug: PR_Delete_
  • Revision title: PR_Delete
  • Revision id: 351357
  • Created:
  • Creator: balah
  • Is current revision? No
  • Comment

Revision Content

Syntax

#include <prio.h> 

PRStatus PR_Delete(const char *name);

Parameters

The function has the following parameter:

name
The pathname of the file to be deleted.

Returns

One of the following values:

  • If file is deleted successfully, PR_SUCCESS.
  • If the file is not deleted, PR_FAILURE.

Description

PR_Delete delete a file with the pathname name. If the function fails, the error code can then be retrieved via PR_GetError.

 

Revision Source

<h3 id="Syntax" name="Syntax">Syntax</h3>
<pre class="eval">
#include &lt;prio.h&gt; 

PRStatus PR_Delete(<span class="k">const</span> <span class="k">char</span> *name);
</pre>
<h3 id="Parameters" name="Parameters">Parameters</h3>
<p>The function has the following parameter:</p>
<dl>
  <dt>
    <code>name</code></dt>
  <dd>
    The pathname of the file to be deleted.</dd>
</dl>
<h3 id="Returns" name="Returns">Returns</h3>
<p>One of the following values:</p>
<ul>
  <li>If file is deleted successfully, <code>PR_SUCCESS</code>.</li>
  <li>If the file is not deleted, <code>PR_FAILURE</code>.</li>
</ul>
<h3 id="Description" name="Description">Description</h3>
<p><code>PR_Delete</code> delete a file with the pathname <code>name</code>. If the function fails, the error code can then be retrieved via <code><a href="https://developer.mozilla.org/en-US/docs/en/PR_GetError">PR_GetError</a></code>.</p>
<dl>
  <dt>
    &nbsp;</dt>
</dl>
Revert to this revision