summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_list_head.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_list_head.rst')
-rw-r--r--docs/nspr/reference/pr_list_head.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_list_head.rst b/docs/nspr/reference/pr_list_head.rst
new file mode 100644
index 0000000000..e930c36295
--- /dev/null
+++ b/docs/nspr/reference/pr_list_head.rst
@@ -0,0 +1,33 @@
+PR_LIST_HEAD
+============
+
+Returns the head of a circular list.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prclist.h>
+
+ PRCList *PR_LIST_HEAD (PRCList *listp);
+
+
+Parameter
+~~~~~~~~~
+
+``listp``
+ A pointer to the linked list.
+
+
+Returns
+~~~~~~~
+
+A pointer to a list element.
+
+
+Description
+-----------
+
+:ref:`PR_LIST_HEAD` returns the head of the specified circular list.