summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_canceljob.rst
blob: 6d49445d75a2c9127c400963df8ea55031a4d5b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
PR_CancelJob
============

Causes a previously queued job to be canceled.


Syntax
------

.. code::

   #include <prtpool.h>

   NSPR_API(PRStatus) PR_CancelJob(PRJob *job);


Parameter
~~~~~~~~~

The function has the following parameter:

``job``
   A pointer to a :ref:`PRJob` structure returned by a :ref:`PR_QueueJob`
   function representing the job to be cancelled.


Returns
~~~~~~~

:ref:`PRStatus`