pr_delete.rst (560B)
1 PR_Delete 2 ========= 3 4 5 Syntax 6 ------ 7 8 .. code:: 9 10 #include <prio.h> 11 12 PRStatus PR_Delete(const char *name); 13 14 15 Parameters 16 ~~~~~~~~~~ 17 18 The function has the following parameter: 19 20 ``name`` 21 The pathname of the file to be deleted. 22 23 24 Returns 25 ~~~~~~~ 26 27 One of the following values: 28 29 - If file is deleted successfully, ``PR_SUCCESS``. 30 - If the file is not deleted, ``PR_FAILURE``. 31 32 33 Description 34 ----------- 35 36 :ref:`PR_Delete` deletes a file with the specified pathname ``name``. If 37 the function fails, the error code can then be retrieved via 38 :ref:`PR_GetError`.