<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_async_proc_h.html</title>\r
+<title>./inc_docs/complib/cl_async_proc_h.html</title>\r
<!-- Source: ./inc/complib/cl_async_proc.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_async_proc.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_async_proc.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
<h2><a name="robo6">[Modules]<a name="Component20Library2fAsynchronous20Processor">\r
Component Library/Asynchronous Processor</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Asynchronous Processor\r
</pre>\r
\r
The threads in the asynchronous processor wait for callbacks to be queued.\r
\r
- The asynchronous processor functions operate on a <a href="#robo276">cl_async_proc_t</a> structure\r
+ The asynchronous processor functions operate on a <a href="#robo280">cl_async_proc_t</a> structure\r
which should be treated as opaque and manipulated only through the provided\r
functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Structures:\r
- <a href="#robo276">cl_async_proc_t</a>, <a href="#robo274">cl_async_proc_item_t</a>\r
+ <a href="#robo280">cl_async_proc_t</a>, <a href="#robo278">cl_async_proc_item_t</a>\r
\r
Initialization:\r
- <a href="#robo271">cl_async_proc_construct</a>, <a href="#robo273">cl_async_proc_init</a>, <a href="#robo272">cl_async_proc_destroy</a>\r
+ <a href="#robo275">cl_async_proc_construct</a>, <a href="#robo277">cl_async_proc_init</a>, <a href="#robo276">cl_async_proc_destroy</a>\r
\r
Manipulation:\r
- <a href="#robo275">cl_async_proc_queue</a>\r
+ <a href="#robo279">cl_async_proc_queue</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo27
1">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fconstruct">
\r+<h2><a name="robo27
5">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fconstruct">
\r Component Library: Asynchronous Processor/cl_async_proc_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_async_proc_construct</strong>(\r
- IN <a href="#robo276">cl_async_proc_t</a>* const p_async_proc );\r
+ IN <a href="#robo280">cl_async_proc_t</a>* const p_async_proc );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_async_proc\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="#robo272">cl_async_proc_destroy</a> without first calling\r
- <a href="#robo273">cl_async_proc_init</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="#robo276">cl_async_proc_destroy</a> without first calling\r
+ <a href="#robo277">cl_async_proc_init</a>.\r
\r
Calling <strong>cl_async_proc_construct</strong> is a prerequisite to calling any other\r
- thread pool function except <a href="#robo273">cl_async_proc_init</a>.\r
+ thread pool function except <a href="#robo277">cl_async_proc_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo273">cl_async_proc_init</a>, <a href="#robo272">cl_async_proc_destroy</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo277">cl_async_proc_init</a>, <a href="#robo276">cl_async_proc_destroy</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo27
2">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fdestroy">
\r+<h2><a name="robo27
6">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fdestroy">
\r Component Library: Asynchronous Processor/cl_async_proc_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_async_proc_destroy</strong>(\r
- IN <a href="#robo276">cl_async_proc_t</a>* const p_async_proc );\r
+ IN <a href="#robo280">cl_async_proc_t</a>* const p_async_proc );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_async_proc\r
entering a wait state is valid from the calling thread context.\r
\r
This function should only be called after a call to\r
- <a href="#robo271">cl_async_proc_construct</a> or <a href="#robo273">cl_async_proc_init</a>.\r
+ <a href="#robo275">cl_async_proc_construct</a> or <a href="#robo277">cl_async_proc_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo271">cl_async_proc_construct</a>, <a href="#robo273">cl_async_proc_init</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo275">cl_async_proc_construct</a>, <a href="#robo277">cl_async_proc_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo27
3">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5finit">
\r+<h2><a name="robo27
7">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5finit">
\r Component Library: Asynchronous Processor/cl_async_proc_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
for use.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_async_proc_init</strong>(\r
- IN <a href="#robo276">cl_async_proc_t</a>* const p_async_proc,\r
+ IN <a href="#robo280">cl_async_proc_t</a>* const p_async_proc,\r
IN const uint32_t thread_count,\r
IN const char* const name );\r
</pre>\r
threads as there are processors in the system.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo271">cl_async_proc_construct</a>, <a href="#robo272">cl_async_proc_destroy</a>,\r
- <a href="#robo275">cl_async_proc_queue</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo275">cl_async_proc_construct</a>, <a href="#robo276">cl_async_proc_destroy</a>,\r
+ <a href="#robo279">cl_async_proc_queue</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo27
4">[Structures]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fitem5ft">
\r+<h2><a name="robo27
8">[Structures]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fitem5ft">
\r Component Library: Asynchronous Processor/cl_async_proc_item_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
<span class="NAME"><pre> <strong>cl_async_proc_item_t</strong>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
-<span class="DESCRIPTION"><pre> Asynchronous processor item structure passed to the <a href="#robo275">cl_async_proc_queue</a>\r
+<span class="DESCRIPTION"><pre> Asynchronous processor item structure passed to the <a href="#robo279">cl_async_proc_queue</a>\r
function to queue a callback for execution.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_async_proc_item\r
{\r
- <a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a> pool_item;\r
- <a href="#robo277">cl_pfn_async_proc_cb_t</a> pfn_callback;\r
+ <a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a> pool_item;\r
+ <a href="#robo281">cl_pfn_async_proc_cb_t</a> pfn_callback;\r
\r
} <strong>cl_async_proc_item_t</strong>;\r
</pre>\r
Pointer to a callback function to invoke when the item is dequeued.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo275">cl_async_proc_queue</a>, <a href="#robo277">cl_pfn_async_proc_cb_t</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo279">cl_async_proc_queue</a>, <a href="#robo281">cl_pfn_async_proc_cb_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo27
5">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fqueue">
\r+<h2><a name="robo27
9">[Functions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5fqueue">
\r Component Library: Asynchronous Processor/cl_async_proc_queue</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_async_proc_queue</strong>(\r
- IN <a href="#robo276">cl_async_proc_t</a>* const p_async_proc,\r
- IN <a href="#robo274">cl_async_proc_item_t</a>* const p_item );\r
+ IN <a href="#robo280">cl_async_proc_t</a>* const p_async_proc,\r
+ IN <a href="#robo278">cl_async_proc_item_t</a>* const p_item );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_async_proc\r
This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo273">cl_async_proc_init</a>, <a href="#robo277">cl_pfn_async_proc_cb_t</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo277">cl_async_proc_init</a>, <a href="#robo281">cl_pfn_async_proc_cb_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
76">[Structures]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5ft">
\r+<h2><a name="robo2
80">[Structures]<a name="Component20Library3a20Asynchronous20Processor2fcl5fasync5fproc5ft">
\r Component Library: Asynchronous Processor/cl_async_proc_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_async_proc\r
{\r
- <a href="./cl_threadpool_h.html#robo667">cl_thread_pool_t</a> thread_pool;\r
- <a href="./cl_qlist_h.html#robo589">cl_qlist_t</a> item_queue;\r
+ <a href="./cl_threadpool_h.html#robo671">cl_thread_pool_t</a> thread_pool;\r
+ <a href="./cl_qlist_h.html#robo593">cl_qlist_t</a> item_queue;\r
cl_spinlock_t lock;\r
cl_state_t state;\r
\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
77">[Definitions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fpfn5fasync5fproc5fcb5ft">
\r+<h2><a name="robo2
81">[Definitions]<a name="Component20Library3a20Asynchronous20Processor2fcl5fpfn5fasync5fproc5fcb5ft">
\r Component Library: Asynchronous Processor/cl_pfn_async_proc_cb_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_item\r
- Pointer to the <a href="#robo274">cl_async_proc_item_t</a> structure that was queued in\r
- a call to <a href="#robo275">cl_async_proc_queue</a>.\r
+ Pointer to the <a href="#robo278">cl_async_proc_item_t</a> structure that was queued in\r
+ a call to <a href="#robo279">cl_async_proc_queue</a>.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for the\r
- function provided by users as a parameter to the <a href="#robo275">cl_async_proc_queue</a>\r
+ function provided by users as a parameter to the <a href="#robo279">cl_async_proc_queue</a>\r
function.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo274">cl_async_proc_item_t</a>\r
+<span class="SEE_ALSO"><pre> Asynchronous Processor, <a href="#robo278">cl_async_proc_item_t</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_atomic_h.html</title>\r
+<title>./inc_docs/complib/cl_atomic_h.html</title>\r
<!-- Source: ./inc/complib/cl_atomic.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_atomic.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_atomic.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
<h2><a name="robo7">[Modules]<a name="Component20Library2fAtomic20Operations">\r
Component Library/Atomic Operations</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Atomic Operations\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
78">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fadd">
\r+<h2><a name="robo2
82">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fadd">
\r Component Library: Atomic Operations/cl_atomic_add</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo281">cl_atomic_inc</a>, <a href="#robo280">cl_atomic_dec</a>, <a href="#robo282">cl_atomic_sub</a>,\r
- <a href="#robo283">cl_atomic_xchg</a>, <a href="#robo279">cl_atomic_comp_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo285">cl_atomic_inc</a>, <a href="#robo284">cl_atomic_dec</a>, <a href="#robo286">cl_atomic_sub</a>,\r
+ <a href="#robo287">cl_atomic_xchg</a>, <a href="#robo283">cl_atomic_comp_xchg</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
79">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fcomp5fxchg">
\r+<h2><a name="robo2
83">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fcomp5fxchg">
\r Component Library: Atomic Operations/cl_atomic_comp_xchg</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo281">cl_atomic_inc</a>, <a href="#robo280">cl_atomic_dec</a>, <a href="#robo278">cl_atomic_add</a>,\r
- <a href="#robo282">cl_atomic_sub</a>, <a href="#robo283">cl_atomic_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo285">cl_atomic_inc</a>, <a href="#robo284">cl_atomic_dec</a>, <a href="#robo282">cl_atomic_add</a>,\r
+ <a href="#robo286">cl_atomic_sub</a>, <a href="#robo287">cl_atomic_xchg</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
0">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fdec">
\r+<h2><a name="robo28
4">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fdec">
\r Component Library: Atomic Operations/cl_atomic_dec</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo281">cl_atomic_inc</a>, <a href="#robo278">cl_atomic_add</a>, <a href="#robo282">cl_atomic_sub</a>,\r
- <a href="#robo283">cl_atomic_xchg</a>, <a href="#robo279">cl_atomic_comp_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo285">cl_atomic_inc</a>, <a href="#robo282">cl_atomic_add</a>, <a href="#robo286">cl_atomic_sub</a>,\r
+ <a href="#robo287">cl_atomic_xchg</a>, <a href="#robo283">cl_atomic_comp_xchg</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
1">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5finc">
\r+<h2><a name="robo28
5">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5finc">
\r Component Library: Atomic Operations/cl_atomic_inc</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo280">cl_atomic_dec</a>, <a href="#robo278">cl_atomic_add</a>, <a href="#robo282">cl_atomic_sub</a>,\r
- <a href="#robo283">cl_atomic_xchg</a>, <a href="#robo279">cl_atomic_comp_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo284">cl_atomic_dec</a>, <a href="#robo282">cl_atomic_add</a>, <a href="#robo286">cl_atomic_sub</a>,\r
+ <a href="#robo287">cl_atomic_xchg</a>, <a href="#robo283">cl_atomic_comp_xchg</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
2">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fsub">
\r+<h2><a name="robo28
6">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fsub">
\r Component Library: Atomic Operations/cl_atomic_sub</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo281">cl_atomic_inc</a>, <a href="#robo280">cl_atomic_dec</a>, <a href="#robo278">cl_atomic_add</a>,\r
- <a href="#robo283">cl_atomic_xchg</a>, <a href="#robo279">cl_atomic_comp_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo285">cl_atomic_inc</a>, <a href="#robo284">cl_atomic_dec</a>, <a href="#robo282">cl_atomic_add</a>,\r
+ <a href="#robo287">cl_atomic_xchg</a>, <a href="#robo283">cl_atomic_comp_xchg</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
3">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fxchg">
\r+<h2><a name="robo28
7">[Functions]<a name="Component20Library3a20Atomic20Operations2fcl5fatomic5fxchg">
\r Component Library: Atomic Operations/cl_atomic_xchg</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
synchronization mechanisms in multi-threaded environments.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo281">cl_atomic_inc</a>, <a href="#robo280">cl_atomic_dec</a>, <a href="#robo278">cl_atomic_add</a>,\r
- <a href="#robo282">cl_atomic_sub</a>, <a href="#robo279">cl_atomic_comp_xchg</a>\r
+<span class="SEE_ALSO"><pre> Atomic Operations, <a href="#robo285">cl_atomic_inc</a>, <a href="#robo284">cl_atomic_dec</a>, <a href="#robo282">cl_atomic_add</a>,\r
+ <a href="#robo286">cl_atomic_sub</a>, <a href="#robo283">cl_atomic_comp_xchg</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_byteswap_h.html</title>\r
+<title>./inc_docs/complib/cl_byteswap_h.html</title>\r
<!-- Source: ./inc/complib/cl_byteswap.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_byteswap.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_byteswap.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
<h2><a name="robo8">[Modules]<a name="Component20Library2fByte20Swapping">\r
Component Library/Byte Swapping</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Byte Swapping\r
</pre>\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Functions:\r
- <a href="#robo291">cl_ntoh16</a>, <a href="#robo284">cl_hton16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo289">cl_hton64</a>,\r
- <a href="#robo290">cl_ntoh</a>\r
+ <a href="#robo296">cl_ntoh16</a>, <a href="#robo289">cl_hton16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo292">cl_hton64</a>,\r
+ <a href="#robo294">cl_ntoh</a>\r
\r
Macros:\r
- <a href="#robo292">CL_NTOH16</a>, <a href="#robo285">CL_HTON16</a>, <a href="#robo293">CL_NTOH32</a>, <a href="#robo287">CL_HTON32</a>, <a href="#robo296">CL_NTOH64</a>, <a href="#robo288">CL_HTON64</a>\r
+ <a href="#robo295">CL_NTOH16</a>, <a href="#robo288">CL_HTON16</a>, <a href="#robo298">CL_NTOH32</a>, <a href="#robo290">CL_HTON32</a>, <a href="#robo300">CL_NTOH64</a>, <a href="#robo293">CL_HTON64</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
5">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON16">
\r+<h2><a name="robo28
8">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON16">
\r Component Library: Byte Swapping/CL_HTON16</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_HTON16</strong> macro converts a 16-bit value from host byte order to\r
network byte order. The <strong>CL_HTON16</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_HTON16</strong> is less efficient\r
- than the <a href="#robo284">cl_hton16</a> function.\r
+ than the <a href="#robo289">cl_hton16</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_HTON16</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo292">CL_NTOH16</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo295">CL_NTOH16</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo292">CL_NTOH16</a>, <a href="#robo287">CL_HTON32</a>, <a href="#robo288">CL_HTON64</a>,\r
- <a href="#robo284">cl_hton16</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo289">cl_hton64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo295">CL_NTOH16</a>, <a href="#robo290">CL_HTON32</a>, <a href="#robo293">CL_HTON64</a>,\r
+ <a href="#robo289">cl_hton16</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo292">cl_hton64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo28
4">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton16">
\r+<h2><a name="robo28
9">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton16">
\r Component Library: Byte Swapping/cl_hton16</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo291">cl_ntoh16</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo296">cl_ntoh16</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo291">cl_ntoh16</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo289">cl_hton64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo296">cl_ntoh16</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo292">cl_hton64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
87">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON32">
\r+<h2><a name="robo2
90">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON32">
\r Component Library: Byte Swapping/CL_HTON32</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_HTON32</strong> macro converts a 32-bit value from host byte order to\r
network byte order. The <strong>CL_HTON32</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_HTON32</strong> is less efficient\r
- than the <a href="#robo286">cl_hton32</a> function.\r
+ than the <a href="#robo291">cl_hton32</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_HTON32</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo293">CL_NTOH32</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo298">CL_NTOH32</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo293">CL_NTOH32</a>, <a href="#robo285">CL_HTON16</a>, <a href="#robo288">CL_HTON64</a>,\r
- <a href="#robo284">cl_hton16</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo289">cl_hton64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo298">CL_NTOH32</a>, <a href="#robo288">CL_HTON16</a>, <a href="#robo293">CL_HTON64</a>,\r
+ <a href="#robo289">cl_hton16</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo292">cl_hton64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
86">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton32">
\r+<h2><a name="robo2
91">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton32">
\r Component Library: Byte Swapping/cl_hton32</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo294">cl_ntoh32</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo297">cl_ntoh32</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo294">cl_ntoh32</a>, <a href="#robo284">cl_hton16</a>, <a href="#robo289">cl_hton64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo297">cl_ntoh32</a>, <a href="#robo289">cl_hton16</a>, <a href="#robo292">cl_hton64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
88">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON64">
\r+<h2><a name="robo2
93">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fHTON64">
\r Component Library: Byte Swapping/CL_HTON64</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_HTON64</strong> macro converts a 64-bit value from host byte order to\r
network byte order. The <strong>CL_HTON64</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_HTON64</strong> is less efficient\r
- than the <a href="#robo289">cl_hton64</a> function.\r
+ than the <a href="#robo292">cl_hton64</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_HTON64</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo296">CL_NTOH64</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo300">CL_NTOH64</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo296">CL_NTOH64</a>, <a href="#robo285">CL_HTON16</a>, <a href="#robo287">CL_HTON32</a>,\r
- <a href="#robo284">cl_hton16</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo289">cl_hton64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo300">CL_NTOH64</a>, <a href="#robo288">CL_HTON16</a>, <a href="#robo290">CL_HTON32</a>,\r
+ <a href="#robo289">cl_hton16</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo292">cl_hton64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo2
89">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton64">
\r+<h2><a name="robo2
92">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fhton64">
\r Component Library: Byte Swapping/cl_hton64</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted to network byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo295">cl_ntoh64</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo299">cl_ntoh64</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo295">cl_ntoh64</a>, <a href="#robo284">cl_hton16</a>, <a href="#robo286">cl_hton32</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo299">cl_ntoh64</a>, <a href="#robo289">cl_hton16</a>, <a href="#robo291">cl_hton32</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
0">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh">
\r+<h2><a name="robo29
4">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh">
\r Component Library: Byte Swapping/cl_ntoh</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
* the destination.\r
*/\r
if( p_src != p_dest )\r
- <a href="./cl_memory_h.html#robo436">cl_memcpy</a>( p_dest, p_src, size );\r
+ <a href="./cl_memory_h.html#robo440">cl_memcpy</a>( p_dest, p_src, size );\r
#endif\r
}\r
</pre>\r
the same buffer.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo291">cl_ntoh16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo295">cl_ntoh64</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo296">cl_ntoh16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo299">cl_ntoh64</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
2">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH16">
\r+<h2><a name="robo29
5">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH16">
\r Component Library: Byte Swapping/CL_NTOH16</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_NTOH16</strong> macro converts a 16-bit value from network byte order to\r
host byte order. The <strong>CL_NTOH16</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_NTOH16</strong> is less efficient\r
- than the <a href="#robo291">cl_ntoh16</a> function.\r
+ than the <a href="#robo296">cl_ntoh16</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_NTOH16</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo285">CL_HTON16</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo288">CL_HTON16</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo285">CL_HTON16</a>, <a href="#robo293">CL_NTOH32</a>, <a href="#robo296">CL_NTOH64</a>,\r
- <a href="#robo291">cl_ntoh16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo288">CL_HTON16</a>, <a href="#robo298">CL_NTOH32</a>, <a href="#robo300">CL_NTOH64</a>,\r
+ <a href="#robo296">cl_ntoh16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
1">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh16">
\r+<h2><a name="robo29
6">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh16">
\r Component Library: Byte Swapping/cl_ntoh16</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted to host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo284">cl_hton16</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo289">cl_hton16</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo284">cl_hton16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo289">cl_hton16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
4">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh32">
\r+<h2><a name="robo29
7">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh32">
\r Component Library: Byte Swapping/cl_ntoh32</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted in host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo286">cl_hton32</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo291">cl_hton32</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo286">cl_hton32</a>, <a href="#robo291">cl_ntoh16</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo291">cl_hton32</a>, <a href="#robo296">cl_ntoh16</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
3">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH32">
\r+<h2><a name="robo29
8">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH32">
\r Component Library: Byte Swapping/CL_NTOH32</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_NTOH32</strong> macro converts a 32-bit value from network byte order to\r
host byte order. The <strong>CL_NTOH32</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_NTOH32</strong> is less efficient\r
- than the <a href="#robo294">cl_ntoh32</a> function.\r
+ than the <a href="#robo297">cl_ntoh32</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_NTOH32</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo287">CL_HTON32</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo290">CL_HTON32</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo287">CL_HTON32</a>, <a href="#robo292">CL_NTOH16</a>, <a href="#robo296">CL_NTOH64</a>,\r
- <a href="#robo291">cl_ntoh16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo290">CL_HTON32</a>, <a href="#robo295">CL_NTOH16</a>, <a href="#robo300">CL_NTOH64</a>,\r
+ <a href="#robo296">cl_ntoh16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
296">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH64">
\r+<h2><a name="robo
300">[Definitions]<a name="Component20Library3a20Byte20Swapping2fCL5fNTOH64">
\r Component Library: Byte Swapping/CL_NTOH64</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>CL_NTOH64</strong> macro converts a 64-bit value from network byte order to\r
host byte order. The <strong>CL_NTOH64</strong> macro will cause constant values to be\r
swapped by the pre-processor. For variables, <strong>CL_NTOH64</strong> is less efficient\r
- than the <a href="#robo295">cl_ntoh64</a> function.\r
+ than the <a href="#robo299">cl_ntoh64</a> function.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_NTOH64</strong>( val );\r
<span class="RESULT"><pre> Value of val converted to host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This macro is analogous to <a href="#robo288">CL_HTON64</a>.\r
+<span class="NOTES"><pre> This macro is analogous to <a href="#robo293">CL_HTON64</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo288">CL_HTON64</a>, <a href="#robo292">CL_NTOH16</a>, <a href="#robo293">CL_NTOH32</a>,\r
- <a href="#robo291">cl_ntoh16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo295">cl_ntoh64</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo293">CL_HTON64</a>, <a href="#robo295">CL_NTOH16</a>, <a href="#robo298">CL_NTOH32</a>,\r
+ <a href="#robo296">cl_ntoh16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo299">cl_ntoh64</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo29
5">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh64">
\r+<h2><a name="robo29
9">[Functions]<a name="Component20Library3a20Byte20Swapping2fcl5fntoh64">
\r Component Library: Byte Swapping/cl_ntoh64</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> Value of val converted in host byte order.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function is analogous to <a href="#robo289">cl_hton64</a>.\r
+<span class="NOTES"><pre> This function is analogous to <a href="#robo292">cl_hton64</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo289">cl_hton64</a>, <a href="#robo291">cl_ntoh16</a>, <a href="#robo294">cl_ntoh32</a>, <a href="#robo290">cl_ntoh</a>\r
+<span class="SEE_ALSO"><pre> Byte Swapping, <a href="#robo292">cl_hton64</a>, <a href="#robo296">cl_ntoh16</a>, <a href="#robo297">cl_ntoh32</a>, <a href="#robo294">cl_ntoh</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_comppool_h.html</title>\r
+<title>./inc_docs/complib/cl_comppool_h.html</title>\r
<!-- Source: ./inc/complib/cl_comppool.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_comppool.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_comppool.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
-<h2><a name="robo
9">[Modules]<a name="Component20Library2fComposite20Pool">
\r+<h2><a name="robo
10">[Modules]<a name="Component20Library2fComposite20Pool">
\r Component Library/Composite Pool</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>\r
</pre>\r
objects to the pool. The only method of returning memory to the system is\r
to destroy the pool.\r
\r
- The composite pool functions operates on a <a href="#robo304">cl_cpool_t</a> structure which\r
+ The composite pool functions operates on a <a href="#robo308">cl_cpool_t</a> structure which\r
should be treated as opaque and should be manipulated only through the\r
provided functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Structures:\r
- <a href="#robo304">cl_cpool_t</a>\r
+ <a href="#robo308">cl_cpool_t</a>\r
\r
Callbacks:\r
- <a href="#robo307">cl_pfn_cpool_init_t</a>, <a href="#robo306">cl_pfn_cpool_dtor_t</a>\r
+ <a href="#robo311">cl_pfn_cpool_init_t</a>, <a href="#robo310">cl_pfn_cpool_dtor_t</a>\r
\r
Initialization/Destruction:\r
- <a href="#robo297">cl_cpool_construct</a>, <a href="#robo302">cl_cpool_init</a>, <a href="#robo299">cl_cpool_destroy</a>\r
+ <a href="#robo301">cl_cpool_construct</a>, <a href="#robo306">cl_cpool_init</a>, <a href="#robo303">cl_cpool_destroy</a>\r
\r
Manipulation:\r
- <a href="#robo300">cl_cpool_get</a>, <a href="#robo303">cl_cpool_put</a>, <a href="#robo301">cl_cpool_grow</a>\r
+ <a href="#robo304">cl_cpool_get</a>, <a href="#robo307">cl_cpool_put</a>, <a href="#robo305">cl_cpool_grow</a>\r
\r
Attributes:\r
- <a href="#robo305">cl_is_cpool_inited</a>, <a href="#robo298">cl_cpool_count</a>\r
+ <a href="#robo309">cl_is_cpool_inited</a>, <a href="#robo302">cl_cpool_count</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
297">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fconstruct">
\r+<h2><a name="robo
301">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fconstruct">
\r Component Library: Composite Pool/cl_cpool_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_cpool_construct</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool );\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure whose state to initialize.\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure whose state to initialize.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="./cl_pool_h.html#robo541">cl_pool_init</a>, <a href="#robo299">cl_cpool_destroy</a>, <a href="#robo305">cl_is_cpool_inited</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="./cl_pool_h.html#robo545">cl_pool_init</a>, <a href="#robo303">cl_cpool_destroy</a>, <a href="#robo309">cl_is_cpool_inited</a>.\r
\r
Calling <strong>cl_cpool_construct</strong> is a prerequisite to calling any other\r
- composite pool function except <a href="#robo302">cl_cpool_init</a>.\r
+ composite pool function except <a href="#robo306">cl_cpool_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo302">cl_cpool_init</a>, <a href="#robo299">cl_cpool_destroy</a>, <a href="#robo305">cl_is_cpool_inited</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo306">cl_cpool_init</a>, <a href="#robo303">cl_cpool_destroy</a>, <a href="#robo309">cl_is_cpool_inited</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
298">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fcount">
\r+<h2><a name="robo
302">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fcount">
\r Component Library: Composite Pool/cl_cpool_count</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE size_t CL_API\r
<strong>cl_cpool_count</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool )\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool )\r
{\r
CL_ASSERT( p_pool );\r
- return( <a href="./cl_qcomppool_h.html#robo549">cl_qcpool_count</a>( &p_pool->qcpool ) );\r
+ return( <a href="./cl_qcomppool_h.html#robo553">cl_qcpool_count</a>( &p_pool->qcpool ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure for which the number of\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure for which the number of\r
available objects is requested.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
299">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fdestroy">
\r+<h2><a name="robo
303">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fdestroy">
\r Component Library: Composite Pool/cl_cpool_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void CL_API\r
<strong>cl_cpool_destroy</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool )\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool )\r
{\r
CL_ASSERT( p_pool );\r
\r
- <a href="./cl_qcomppool_h.html#robo550">cl_qcpool_destroy</a>( &p_pool->qcpool );\r
+ <a href="./cl_qcomppool_h.html#robo554">cl_qcpool_destroy</a>( &p_pool->qcpool );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure to destroy.\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure to destroy.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
operations on the composite pool should not be attempted after\r
<strong>cl_cpool_destroy</strong> is invoked.\r
\r
- This function should only be called after a call to <a href="#robo297">cl_cpool_construct</a>.\r
+ This function should only be called after a call to <a href="#robo301">cl_cpool_construct</a>.\r
\r
In a debug build, <strong>cl_cpool_destroy</strong> asserts that all objects are in\r
the pool.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo297">cl_cpool_construct</a>, <a href="#robo302">cl_cpool_init</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo301">cl_cpool_construct</a>, <a href="#robo306">cl_cpool_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
0">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fget">
\r+<h2><a name="robo30
4">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fget">
\r Component Library: Composite Pool/cl_cpool_get</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void* CL_API\r
<strong>cl_cpool_get</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool )\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_pool );\r
\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qcomppool_h.html#robo551">cl_qcpool_get</a>( &p_pool->qcpool );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qcomppool_h.html#robo555">cl_qcpool_get</a>( &p_pool->qcpool );\r
if( !p_pool_obj )\r
return( NULL );\r
\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure from which to retrieve\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure from which to retrieve\r
an object.\r
\r
RETURN VALUES\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> <strong>cl_cpool_get</strong> returns the object at the head of the pool. If the pool is\r
empty, it is automatically grown to accommodate this request unless the\r
- grow_size parameter passed to the <a href="#robo302">cl_cpool_init</a> function was zero.\r
+ grow_size parameter passed to the <a href="#robo306">cl_cpool_init</a> function was zero.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, cl_cpool_get_tail, <a href="#robo303">cl_cpool_put</a>, <a href="#robo301">cl_cpool_grow</a>,\r
- <a href="#robo298">cl_cpool_count</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, cl_cpool_get_tail, <a href="#robo307">cl_cpool_put</a>, <a href="#robo305">cl_cpool_grow</a>,\r
+ <a href="#robo302">cl_cpool_count</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
1">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fgrow">
\r+<h2><a name="robo30
5">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fgrow">
\r Component Library: Composite Pool/cl_cpool_grow</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the specified number of objects.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_cpool_grow</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool,\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool,\r
IN const size_t obj_count )\r
{\r
CL_ASSERT( p_pool );\r
- return( <a href="./cl_qcomppool_h.html#robo552">cl_qcpool_grow</a>( &p_pool->qcpool, obj_count ) );\r
+ return( <a href="./cl_qcomppool_h.html#robo556">cl_qcpool_grow</a>( &p_pool->qcpool, obj_count ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure whose capacity to grow.\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure whose capacity to grow.\r
\r
obj_count\r
[in] Number of objects by which to grow the pool.\r
CL_INSUFFICIENT_MEMORY if there was not enough memory to grow the\r
composite pool.\r
\r
- <a href="./cl_types_h.html#robo309">cl_status_t</a> value returned by optional initialization callback function\r
+ <a href="./cl_types_h.html#robo313">cl_status_t</a> value returned by optional initialization callback function\r
specified by the pfn_initializer parameter passed to the\r
- <a href="#robo302">cl_cpool_init</a> function.\r
+ <a href="#robo306">cl_cpool_init</a> function.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> It is not necessary to call <strong>cl_cpool_grow</strong> if the pool is\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
2">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5finit">
\r+<h2><a name="robo30
6">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5finit">
\r Component Library: Composite Pool/cl_cpool_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_cpool_init</strong> function initializes a composite pool for use.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_cpool_init</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool,\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool,\r
IN const size_t min_size,\r
IN const size_t max_size,\r
IN const size_t grow_size,\r
IN size_t* const component_sizes,\r
IN const uint32_t num_components,\r
- IN <a href="#robo307">cl_pfn_cpool_init_t</a> pfn_initializer OPTIONAL,\r
- IN <a href="#robo306">cl_pfn_cpool_dtor_t</a> pfn_destructor OPTIONAL,\r
+ IN <a href="#robo311">cl_pfn_cpool_init_t</a> pfn_initializer OPTIONAL,\r
+ IN <a href="#robo310">cl_pfn_cpool_dtor_t</a> pfn_destructor OPTIONAL,\r
IN const void* const context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure to initialize.\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure to initialize.\r
\r
min_size\r
[in] Minimum number of objects that the pool should support. All\r
consisting of more than one component. Also returns CL_INVALID_SETTING if\r
the maximum size is non-zero and less than the minimum size.\r
\r
- Other <a href="./cl_types_h.html#robo309">cl_status_t</a> value returned by optional initialization callback function\r
+ Other <a href="./cl_types_h.html#robo313">cl_status_t</a> value returned by optional initialization callback function\r
specified by the pfn_initializer parameter.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
the capacity desired.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo297">cl_cpool_construct</a>, <a href="#robo299">cl_cpool_destroy</a>,\r
- <a href="#robo300">cl_cpool_get</a>, <a href="#robo303">cl_cpool_put</a>, <a href="#robo301">cl_cpool_grow</a>,\r
- <a href="#robo298">cl_cpool_count</a>, cl_pfn_cpool_ctor_t, <a href="#robo307">cl_pfn_cpool_init_t</a>,\r
- <a href="#robo306">cl_pfn_cpool_dtor_t</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo301">cl_cpool_construct</a>, <a href="#robo303">cl_cpool_destroy</a>,\r
+ <a href="#robo304">cl_cpool_get</a>, <a href="#robo307">cl_cpool_put</a>, <a href="#robo305">cl_cpool_grow</a>,\r
+ <a href="#robo302">cl_cpool_count</a>, cl_pfn_cpool_ctor_t, <a href="#robo311">cl_pfn_cpool_init_t</a>,\r
+ <a href="#robo310">cl_pfn_cpool_dtor_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
3">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fput">
\r+<h2><a name="robo30
7">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5fput">
\r Component Library: Composite Pool/cl_cpool_put</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void CL_API\r
<strong>cl_cpool_put</strong>(\r
- IN <a href="#robo304">cl_cpool_t</a>* const p_pool,\r
+ IN <a href="#robo308">cl_cpool_t</a>* const p_pool,\r
IN void* const p_object )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
/* good sanity check */\r
CL_ASSERT( p_pool_obj->list_obj.p_object == p_object );\r
\r
- <a href="./cl_qcomppool_h.html#robo554">cl_qcpool_put</a>( &p_pool->qcpool, (<a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a>*)p_pool_obj );\r
+ <a href="./cl_qcomppool_h.html#robo558">cl_qcpool_put</a>( &p_pool->qcpool, (<a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a>*)p_pool_obj );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure to which to return\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure to which to return\r
an object.\r
\r
p_object\r
<span class="NOTES"><pre> <strong>cl_cpool_put</strong> places the returned object at the head of the pool.\r
\r
The object specified by the p_object parameter must have been\r
- retrieved from the pool by a previous call to <a href="#robo300">cl_cpool_get</a>.\r
+ retrieved from the pool by a previous call to <a href="#robo304">cl_cpool_get</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, cl_cpool_put_tail, <a href="#robo300">cl_cpool_get</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, cl_cpool_put_tail, <a href="#robo304">cl_cpool_get</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
4">[Structures]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5ft">
\r+<h2><a name="robo30
8">[Structures]<a name="Component20Library3a20Composite20Pool2fcl5fcpool5ft">
\r Component Library: Composite Pool/cl_cpool_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_cpool\r
{\r
- <a href="./cl_qcomppool_h.html#robo556">cl_qcpool_t</a> qcpool;\r
- <a href="#robo307">cl_pfn_cpool_init_t</a> pfn_init;\r
- <a href="#robo306">cl_pfn_cpool_dtor_t</a> pfn_dtor;\r
+ <a href="./cl_qcomppool_h.html#robo560">cl_qcpool_t</a> qcpool;\r
+ <a href="#robo311">cl_pfn_cpool_init_t</a> pfn_init;\r
+ <a href="#robo310">cl_pfn_cpool_dtor_t</a> pfn_dtor;\r
const void *context;\r
\r
} <strong>cl_cpool_t</strong>;\r
</span>\r
<hr />\r
\r
-<h2><a name="robo30
5">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fis5fcpool5finited">
\r+<h2><a name="robo30
9">[Functions]<a name="Component20Library3a20Composite20Pool2fcl5fis5fcpool5finited">
\r Component Library: Composite Pool/cl_is_cpool_inited</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_cpool_inited</strong>(\r
- IN const <a href="#robo304">cl_cpool_t</a>* const p_pool )\r
+ IN const <a href="#robo308">cl_cpool_t</a>* const p_pool )\r
{\r
/* CL_ASSERT that a non-null pointer is provided. */\r
CL_ASSERT( p_pool );\r
- return( <a href="./cl_qcomppool_h.html#robo544">cl_is_qcpool_inited</a>( &p_pool->qcpool ) );\r
+ return( <a href="./cl_qcomppool_h.html#robo548">cl_is_qcpool_inited</a>( &p_pool->qcpool ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_pool\r
- [in] Pointer to a <a href="#robo304">cl_cpool_t</a> structure whose initialization state\r
+ [in] Pointer to a <a href="#robo308">cl_cpool_t</a> structure whose initialization state\r
to check.\r
\r
RETURN VALUES\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
06">[Definitions]<a name="Component20Library3a20Composite20Pool2fcl5fpfn5fcpool5fdtor5ft">
\r+<h2><a name="robo3
10">[Definitions]<a name="Component20Library3a20Composite20Pool2fcl5fpfn5fcpool5fdtor5ft">
\r Component Library: Composite Pool/cl_pfn_cpool_dtor_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
[in] Pointer to an object to destruct.\r
\r
context\r
- [in] Context provided in the call to <a href="#robo302">cl_cpool_init</a>.\r
+ [in] Context provided in the call to <a href="#robo306">cl_cpool_init</a>.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for\r
the function provided by the user as an optional parameter to the\r
- <a href="#robo302">cl_cpool_init</a> function.\r
+ <a href="#robo306">cl_cpool_init</a> function.\r
\r
The destructor is invoked once per allocated object, allowing the user\r
to perform any necessary cleanup. Users should not attempt to deallocate\r
object allocation and deallocation.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo302">cl_cpool_init</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo306">cl_cpool_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
07">[Definitions]<a name="Component20Library3a20Composite20Pool2fcl5fpfn5fcpool5finit5ft">
\r+<h2><a name="robo3
11">[Definitions]<a name="Component20Library3a20Composite20Pool2fcl5fpfn5fcpool5finit5ft">
\r Component Library: Composite Pool/cl_pfn_cpool_init_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
composite pool.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo309">cl_status_t</a>\r
+<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo313">cl_status_t</a>\r
(CL_API *<strong>cl_pfn_cpool_init_t</strong>)(\r
IN void** const p_comp_array,\r
IN const uint32_t num_components,\r
[in] Pointer to an object to initialize.\r
\r
context\r
- [in] Context provided in a call to <a href="#robo302">cl_cpool_init</a>.\r
+ [in] Context provided in a call to <a href="#robo306">cl_cpool_init</a>.\r
\r
RETURN VALUES\r
Return CL_SUCCESS to indicates that initialization of the object\r
was successful and that initialization of further objects may continue.\r
\r
- Other <a href="./cl_types_h.html#robo309">cl_status_t</a> values will be returned by <a href="#robo302">cl_cpool_init</a>\r
- and <a href="#robo301">cl_cpool_grow</a>.\r
+ Other <a href="./cl_types_h.html#robo313">cl_status_t</a> values will be returned by <a href="#robo306">cl_cpool_init</a>\r
+ and <a href="#robo305">cl_cpool_grow</a>.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for\r
the function provided by the user as an optional parameter to the\r
- <a href="#robo302">cl_cpool_init</a> function.\r
+ <a href="#robo306">cl_cpool_init</a> function.\r
\r
The initializer is invoked once per allocated object, allowing the user\r
to chain components to form a composite object and perform any necessary\r
initialization. Returning a status other than CL_SUCCESS aborts a grow\r
- operation, initiated either through <a href="#robo302">cl_cpool_init</a> or <a href="#robo301">cl_cpool_grow</a>, and\r
+ operation, initiated either through <a href="#robo306">cl_cpool_init</a> or <a href="#robo305">cl_cpool_grow</a>, and\r
causes the initiating function to fail. Any non-CL_SUCCESS status will\r
be returned by the function that initiated the grow operation.\r
\r
All memory for the requested number of components is pre-allocated.\r
\r
- When later performing a <a href="#robo300">cl_cpool_get</a> call, the return value is a pointer\r
+ When later performing a <a href="#robo304">cl_cpool_get</a> call, the return value is a pointer\r
to the first component.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo302">cl_cpool_init</a>, <a href="#robo301">cl_cpool_grow</a>\r
+<span class="SEE_ALSO"><pre> Composite <a href="./cl_pool_h.html#robo24">Pool</a>, <a href="#robo306">cl_cpool_init</a>, <a href="#robo305">cl_cpool_grow</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_debug_h.html</title>\r
+<title>./inc_docs/complib/cl_debug_h.html</title>\r
<!-- Source: ./inc/complib/cl_debug.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_debug.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_debug.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
0">[Modules]<a name="Component20Library2fDebug20Output">
\r+<h2><a name="robo1
1">[Modules]<a name="Component20Library2fDebug20Output">
\r Component Library/Debug Output</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Debug Output\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
0">[Definitions]<a name="Component20Library3a20Debug20Output2f642dbit20Print20Format">
\r+<h2><a name="robo31
4">[Definitions]<a name="Component20Library3a20Debug20Output2f642dbit20Print20Format">
\r Component Library: Debug Output/64-bit Print Format</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
</span><p><strong>EXAMPLE</strong></p>\r
<span class="EXAMPLE"><pre> uint64 MyVal = 2;\r
// Print a 64-bit integer in hexadecimal format.\r
- <a href="#robo312">cl_dbg_out</a>( "MyVal: 0x%" PRIx64 "\n", MyVal );\r
+ <a href="#robo316">cl_dbg_out</a>( "MyVal: 0x%" PRIx64 "\n", MyVal );\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> Standard print flags to specify padding and precision can still be used\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
1">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fbreak">
\r+<h2><a name="robo31
5">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fbreak">
\r Component Library: Debug Output/cl_break</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
2">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fdbg5fout">
\r+<h2><a name="robo31
6">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fdbg5fout">
\r Component Library: Debug Output/cl_dbg_out</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<strong>cl_dbg_out</strong> sends the debug message to the current debug target.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo315">cl_msg_out</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo319">cl_msg_out</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
3">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fENTER">
\r+<h2><a name="robo31
7">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fENTER">
\r Component Library: Debug Output/CL_ENTER</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
my_func()\r
{\r
<strong>CL_ENTER</strong>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
- <a href="#robo314">CL_EXIT</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
+ <a href="#robo318">CL_EXIT</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
}\r
</pre>\r
</span><p><strong>RESULT</strong></p>\r
is generated is prepended to the output.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo316">CL_PRINT</a>, <a href="#robo314">CL_EXIT</a>, <a href="#robo317">CL_TRACE</a>, <a href="#robo318">CL_TRACE_EXIT</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo320">CL_PRINT</a>, <a href="#robo318">CL_EXIT</a>, <a href="#robo321">CL_TRACE</a>, <a href="#robo322">CL_TRACE_EXIT</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
4">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fEXIT">
\r+<h2><a name="robo31
8">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fEXIT">
\r Component Library: Debug Output/CL_EXIT</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
void\r
my_func()\r
{\r
- <a href="#robo313">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
+ <a href="#robo317">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
<strong>CL_EXIT</strong>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
}\r
</pre>\r
is generated is prepended to the output.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo316">CL_PRINT</a>, <a href="#robo313">CL_ENTER</a>, <a href="#robo317">CL_TRACE</a>, <a href="#robo318">CL_TRACE_EXIT</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo320">CL_PRINT</a>, <a href="#robo317">CL_ENTER</a>, <a href="#robo321">CL_TRACE</a>, <a href="#robo322">CL_TRACE_EXIT</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo31
5">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fmsg5fout">
\r+<h2><a name="robo31
9">[Functions]<a name="Component20Library3a20Debug20Output2fcl5fmsg5fout">
\r Component Library: Debug Output/cl_msg_out</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<strong>cl_msg_out</strong> sends the message to the current message logging target.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo312">cl_dbg_out</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo316">cl_dbg_out</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
16">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fPRINT">
\r+<h2><a name="robo3
20">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fPRINT">
\r Component Library: Debug Output/CL_PRINT</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
is generated is prepended to the output.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo313">CL_ENTER</a>, <a href="#robo314">CL_EXIT</a>, <a href="#robo317">CL_TRACE</a>, <a href="#robo318">CL_TRACE_EXIT</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo317">CL_ENTER</a>, <a href="#robo318">CL_EXIT</a>, <a href="#robo321">CL_TRACE</a>, <a href="#robo322">CL_TRACE_EXIT</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
17">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fTRACE">
\r+<h2><a name="robo3
21">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fTRACE">
\r Component Library: Debug Output/CL_TRACE</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
void\r
my_func()\r
{\r
- <a href="#robo313">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
+ <a href="#robo317">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
<strong>CL_TRACE</strong>( MY_FUNC_DBG_LVL, my_dbg_lvl, ("Hello %s!\n", "world") );\r
- <a href="#robo314">CL_EXIT</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
+ <a href="#robo318">CL_EXIT</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
}\r
</pre>\r
</span><p><strong>RESULT</strong></p>\r
is generated is prepended to the output.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo316">CL_PRINT</a>, <a href="#robo313">CL_ENTER</a>, <a href="#robo314">CL_EXIT</a>, <a href="#robo318">CL_TRACE_EXIT</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo320">CL_PRINT</a>, <a href="#robo317">CL_ENTER</a>, <a href="#robo318">CL_EXIT</a>, <a href="#robo322">CL_TRACE_EXIT</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
18">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fTRACE5fEXIT">
\r+<h2><a name="robo3
22">[Definitions]<a name="Component20Library3a20Debug20Output2fCL5fTRACE5fEXIT">
\r Component Library: Debug Output/CL_TRACE_EXIT</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="NAME"><pre> <strong>CL_TRACE_EXIT</strong>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
-<span class="DESCRIPTION"><pre> The <strong>CL_TRACE_EXIT</strong> macro combines the functionality of the <a href="#robo317">CL_TRACE</a> and\r
- <a href="#robo314">CL_EXIT</a> macros, in that order.\r
+<span class="DESCRIPTION"><pre> The <strong>CL_TRACE_EXIT</strong> macro combines the functionality of the <a href="#robo321">CL_TRACE</a> and\r
+ <a href="#robo318">CL_EXIT</a> macros, in that order.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>* <strong>CL_TRACE_EXIT</strong>( DBG_LVL, CHK_LVL, STRING );\r
void\r
my_func()\r
{\r
- <a href="#robo313">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
+ <a href="#robo317">CL_ENTER</a>( MY_FUNC_DBG_LVL, my_dbg_lvl );\r
<strong>CL_TRACE_EXIT</strong>( MY_FUNC_DBG_LVL, my_dbg_lvl, ("Hello %s!\n", "world") );\r
}\r
</pre>\r
is generated is prepended to the output.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo316">CL_PRINT</a>, <a href="#robo313">CL_ENTER</a>, <a href="#robo314">CL_EXIT</a>, <a href="#robo317">CL_TRACE</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, Debug Levels, <a href="#robo320">CL_PRINT</a>, <a href="#robo317">CL_ENTER</a>, <a href="#robo318">CL_EXIT</a>, <a href="#robo321">CL_TRACE</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
19">[Definitions]<a name="Component20Library3a20Debug20Output2fDebug20Levels">
\r+<h2><a name="robo3
23">[Definitions]<a name="Component20Library3a20Debug20Output2fDebug20Levels">
\r Component Library: Debug Output/Debug Levels</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
all bits whose output they are interested in.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo316">CL_PRINT</a>, <a href="#robo313">CL_ENTER</a>, <a href="#robo314">CL_EXIT</a>, <a href="#robo317">CL_TRACE</a>, <a href="#robo318">CL_TRACE_EXIT</a>\r
+<span class="SEE_ALSO"><pre> Debug Output, <a href="#robo320">CL_PRINT</a>, <a href="#robo317">CL_ENTER</a>, <a href="#robo318">CL_EXIT</a>, <a href="#robo321">CL_TRACE</a>, <a href="#robo322">CL_TRACE_EXIT</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_event_h.html</title>\r
+<title>./inc_docs/complib/cl_event_h.html</title>\r
<!-- Source: ./inc/complib/cl_event.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_event.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_event.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
1">[Modules]<a name="Component20Library2fEvent">
\r+<h2><a name="robo1
2">[Modules]<a name="Component20Library2fEvent">
\r Component Library/Event</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> <strong>Event</strong>\r
</pre>\r
cl_event_t\r
\r
Initialization/Destruction:\r
- <a href="#robo321">cl_event_construct</a>, <a href="#robo323">cl_event_init</a>, <a href="#robo322">cl_event_destroy</a>\r
+ <a href="#robo325">cl_event_construct</a>, <a href="#robo327">cl_event_init</a>, <a href="#robo326">cl_event_destroy</a>\r
\r
Manipulation:\r
- <a href="#robo325">cl_event_signal</a>, <a href="#robo324">cl_event_reset</a>, <a href="#robo326">cl_event_wait_on</a>\r
+ <a href="#robo329">cl_event_signal</a>, <a href="#robo328">cl_event_reset</a>, <a href="#robo330">cl_event_wait_on</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo32
1">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fconstruct">
\r+<h2><a name="robo32
5">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fconstruct">
\r Component Library: Event/cl_event_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="#robo322">cl_event_destroy</a> without first calling <a href="#robo323">cl_event_init</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="#robo326">cl_event_destroy</a> without first calling <a href="#robo327">cl_event_init</a>.\r
\r
Calling <strong>cl_event_construct</strong> is a prerequisite to calling any other event\r
- function except <a href="#robo323">cl_event_init</a>.\r
+ function except <a href="#robo327">cl_event_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo323">cl_event_init</a>, <a href="#robo322">cl_event_destroy</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo327">cl_event_init</a>, <a href="#robo326">cl_event_destroy</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo32
2">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fdestroy">
\r+<h2><a name="robo32
6">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fdestroy">
\r Component Library: Event/cl_event_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> This function should only be called after a call to <a href="#robo321">cl_event_construct</a>\r
- or <a href="#robo323">cl_event_init</a>.\r
+<span class="NOTES"><pre> This function should only be called after a call to <a href="#robo325">cl_event_construct</a>\r
+ or <a href="#robo327">cl_event_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo321">cl_event_construct</a>, <a href="#robo323">cl_event_init</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo325">cl_event_construct</a>, <a href="#robo327">cl_event_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo32
3">[Functions]<a name="Component20Library3a20Event2fcl5fevent5finit">
\r+<h2><a name="robo32
7">[Functions]<a name="Component20Library3a20Event2fcl5fevent5finit">
\r Component Library: Event/cl_event_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_event_init</strong> function initializes an event for use.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_event_init</strong>(\r
IN cl_event_t* const p_event,\r
IN const boolean_t manual_reset );\r
manual_reset\r
[in] If FALSE, indicates that the event resets itself after releasing\r
a single waiter. If TRUE, the event remains in the signalled state\r
- until explicitly reset by a call to <a href="#robo324">cl_event_reset</a>.\r
+ until explicitly reset by a call to <a href="#robo328">cl_event_reset</a>.\r
\r
RETURN VALUES\r
CL_SUCCESS if event initialization succeeded.\r
CL_ERROR otherwise.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling event manipulation functions, such as <a href="#robo325">cl_event_signal</a>,\r
- <a href="#robo324">cl_event_reset</a>, and <a href="#robo326">cl_event_wait_on</a>.\r
+<span class="NOTES"><pre> Allows calling event manipulation functions, such as <a href="#robo329">cl_event_signal</a>,\r
+ <a href="#robo328">cl_event_reset</a>, and <a href="#robo330">cl_event_wait_on</a>.\r
\r
The event is initially in a reset state.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo321">cl_event_construct</a>, <a href="#robo322">cl_event_destroy</a>, <a href="#robo325">cl_event_signal</a>,\r
- <a href="#robo324">cl_event_reset</a>, <a href="#robo326">cl_event_wait_on</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo325">cl_event_construct</a>, <a href="#robo326">cl_event_destroy</a>, <a href="#robo329">cl_event_signal</a>,\r
+ <a href="#robo328">cl_event_reset</a>, <a href="#robo330">cl_event_wait_on</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo32
4">[Functions]<a name="Component20Library3a20Event2fcl5fevent5freset">
\r+<h2><a name="robo32
8">[Functions]<a name="Component20Library3a20Event2fcl5fevent5freset">
\r Component Library: Event/cl_event_reset</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_event_reset</strong> function sets an event to the non-signalled state.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_event_reset</strong>(\r
IN cl_event_t* const p_event );\r
</pre>\r
CL_ERROR otherwise.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo325">cl_event_signal</a>, <a href="#robo326">cl_event_wait_on</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo329">cl_event_signal</a>, <a href="#robo330">cl_event_wait_on</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo32
5">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fsignal">
\r+<h2><a name="robo32
9">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fsignal">
\r Component Library: Event/cl_event_signal</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
releases one or more waiting threads.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_event_signal</strong>(\r
IN cl_event_t* const p_event );\r
</pre>\r
that is already in the signalled state has no effect.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo324">cl_event_reset</a>, <a href="#robo326">cl_event_wait_on</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo328">cl_event_reset</a>, <a href="#robo330">cl_event_wait_on</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
26">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fwait5fon">
\r+<h2><a name="robo3
30">[Functions]<a name="Component20Library3a20Event2fcl5fevent5fwait5fon">
\r Component Library: Event/cl_event_wait_on</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
triggered for a minimum amount of time.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_event_wait_on</strong>(\r
IN cl_event_t* const p_event,\r
IN const uint32_t wait_us,\r
to <strong>cl_event_wait_on</strong>, the call completes immediately with CL_SUCCESS.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo11">Event</a>, <a href="#robo325">cl_event_signal</a>, <a href="#robo324">cl_event_reset</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo12">Event</a>, <a href="#robo329">cl_event_signal</a>, <a href="#robo328">cl_event_reset</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_fleximap_h.html</title>\r
+<title>./inc_docs/complib/cl_fleximap_h.html</title>\r
<!-- Source: ./inc/complib/cl_fleximap.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_fleximap.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_fleximap.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
2">[Modules]<a name="Component20Library2fFlexi20Map">
\r+<h2><a name="robo1
3">[Modules]<a name="Component20Library2fFlexi20Map">
\r Component Library/Flexi Map</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
-<span class="NAME"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>\r
+<span class="NAME"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
-<span class="DESCRIPTION"><pre> Flexi map implements a binary tree that stores user provided <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="DESCRIPTION"><pre> Flexi map implements a binary tree that stores user provided <a href="#robo340">cl_fmap_item_t</a>\r
structures. Each item stored in a flexi map has a unique user defined key\r
(duplicates are not allowed). Flexi map provides the ability to\r
efficiently search for an item given a key. Flexi map allows user defined\r
Flexi map is not thread safe, and users must provide serialization when\r
adding and removing items from the map.\r
\r
- The flexi map functions operate on a <a href="#robo344">cl_fmap_t</a> structure which should\r
+ The flexi map functions operate on a <a href="#robo348">cl_fmap_t</a> structure which should\r
be treated as opaque and should be manipulated only through the provided\r
functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Structures:\r
- <a href="#robo344">cl_fmap_t</a>, <a href="#robo336">cl_fmap_item_t</a>\r
+ <a href="#robo348">cl_fmap_t</a>, <a href="#robo340">cl_fmap_item_t</a>\r
\r
Callbacks:\r
- <a href="#robo347">cl_pfn_fmap_apply_t</a>\r
+ <a href="#robo351">cl_pfn_fmap_apply_t</a>\r
\r
Item Manipulation:\r
- <a href="#robo337">cl_fmap_key</a>\r
+ <a href="#robo341">cl_fmap_key</a>\r
\r
Initialization:\r
- <a href="#robo334">cl_fmap_init</a>\r
+ <a href="#robo338">cl_fmap_init</a>\r
\r
Iteration:\r
- <a href="#robo331">cl_fmap_end</a>, <a href="#robo333">cl_fmap_head</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo339">cl_fmap_next</a>, <a href="#robo340">cl_fmap_prev</a>\r
+ <a href="#robo335">cl_fmap_end</a>, <a href="#robo337">cl_fmap_head</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo343">cl_fmap_next</a>, <a href="#robo344">cl_fmap_prev</a>\r
\r
Manipulation:\r
- <a href="#robo335">cl_fmap_insert</a>, <a href="#robo332">cl_fmap_get</a>, <a href="#robo343">cl_fmap_remove_item</a>, <a href="#robo341">cl_fmap_remove</a>,\r
- <a href="#robo342">cl_fmap_remove_all</a>, <a href="#robo338">cl_fmap_merge</a>, <a href="#robo330">cl_fmap_delta</a>\r
+ <a href="#robo339">cl_fmap_insert</a>, <a href="#robo336">cl_fmap_get</a>, <a href="#robo347">cl_fmap_remove_item</a>, <a href="#robo345">cl_fmap_remove</a>,\r
+ <a href="#robo346">cl_fmap_remove_all</a>, <a href="#robo342">cl_fmap_merge</a>, <a href="#robo334">cl_fmap_delta</a>\r
\r
Search:\r
- <a href="#robo328">cl_fmap_apply_func</a>\r
+ <a href="#robo332">cl_fmap_apply_func</a>\r
\r
Attributes:\r
- <a href="#robo329">cl_fmap_count</a>, <a href="#robo346">cl_is_fmap_empty</a>,\r
+ <a href="#robo333">cl_fmap_count</a>, <a href="#robo350">cl_is_fmap_empty</a>,\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
28">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fapply5ffunc">
\r+<h2><a name="robo3
32">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fapply5ffunc">
\r Component Library: Flexi Map/cl_fmap_apply_func</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_fmap_apply_func</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map,\r
- IN <a href="#robo347">cl_pfn_fmap_apply_t</a> pfn_func,\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map,\r
+ IN <a href="#robo351">cl_pfn_fmap_apply_t</a> pfn_func,\r
IN const void* const context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure.\r
\r
pfn_func\r
[in] Function invoked for every item in the flexi map.\r
- See the <a href="#robo347">cl_pfn_fmap_apply_t</a> function type declaration for details\r
+ See the <a href="#robo351">cl_pfn_fmap_apply_t</a> function type declaration for details\r
about the callback function.\r
\r
context\r
would corrupt the flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo347">cl_pfn_fmap_apply_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo351">cl_pfn_fmap_apply_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
29">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fcount">
\r+<h2><a name="robo3
33">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fcount">
\r Component Library: Flexi Map/cl_fmap_count</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE size_t CL_API\r
<strong>cl_fmap_count</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure whose item count to return.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure whose item count to return.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> Returns the number of items stored in the map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo346">cl_is_fmap_empty</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo350">cl_is_fmap_empty</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
0">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fdelta">
\r+<h2><a name="robo33
4">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fdelta">
\r Component Library: Flexi Map/cl_fmap_delta</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_fmap_delta</strong>(\r
- IN OUT <a href="#robo344">cl_fmap_t</a>* const p_map1,\r
- IN OUT <a href="#robo344">cl_fmap_t</a>* const p_map2,\r
- OUT <a href="#robo344">cl_fmap_t</a>* const p_new,\r
- OUT <a href="#robo344">cl_fmap_t</a>* const p_old );\r
+ IN OUT <a href="#robo348">cl_fmap_t</a>* const p_map1,\r
+ IN OUT <a href="#robo348">cl_fmap_t</a>* const p_map2,\r
+ OUT <a href="#robo348">cl_fmap_t</a>* const p_new,\r
+ OUT <a href="#robo348">cl_fmap_t</a>* const p_old );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map1\r
- [in/out] Pointer to the first of two <a href="#robo344">cl_fmap_t</a> structures whose\r
+ [in/out] Pointer to the first of two <a href="#robo348">cl_fmap_t</a> structures whose\r
differences to compute.\r
\r
p_map2\r
- [in/out] Pointer to the second of two <a href="#robo344">cl_fmap_t</a> structures whose\r
+ [in/out] Pointer to the second of two <a href="#robo348">cl_fmap_t</a> structures whose\r
differences to compute.\r
\r
p_new\r
- [out] Pointer to an empty <a href="#robo344">cl_fmap_t</a> structure that contains the items\r
+ [out] Pointer to an empty <a href="#robo348">cl_fmap_t</a> structure that contains the items\r
unique to p_map2 upon return from the function.\r
\r
p_old\r
- [out] Pointer to an empty <a href="#robo344">cl_fmap_t</a> structure that contains the items\r
+ [out] Pointer to an empty <a href="#robo348">cl_fmap_t</a> structure that contains the items\r
unique to p_map1 upon return from the function.\r
\r
RETURN VALUES\r
requirement removes the possibility of failures.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo338">cl_fmap_merge</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo342">cl_fmap_merge</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
1">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fend">
\r+<h2><a name="robo33
5">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fend">
\r Component Library: Flexi Map/cl_fmap_end</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_fmap_end</strong> function returns the end of a flexi map.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo336">cl_fmap_item_t</a>* const CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo340">cl_fmap_item_t</a>* const CL_API\r
<strong>cl_fmap_end</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure whose end to return.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure whose end to return.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> Pointer to the end of the map.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> <strong>cl_fmap_end</strong> is useful for determining the validity of map items returned\r
- by <a href="#robo333">cl_fmap_head</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo339">cl_fmap_next</a>, or <a href="#robo340">cl_fmap_prev</a>. If the map\r
+ by <a href="#robo337">cl_fmap_head</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo343">cl_fmap_next</a>, or <a href="#robo344">cl_fmap_prev</a>. If the map\r
item pointer returned by any of these functions compares to the end, the\r
end of the map was encoutered.\r
- When using <a href="#robo333">cl_fmap_head</a> or <a href="#robo345">cl_fmap_tail</a>, this condition indicates that\r
+ When using <a href="#robo337">cl_fmap_head</a> or <a href="#robo349">cl_fmap_tail</a>, this condition indicates that\r
the map is empty.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo333">cl_fmap_head</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo339">cl_fmap_next</a>, <a href="#robo340">cl_fmap_prev</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo337">cl_fmap_head</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo343">cl_fmap_next</a>, <a href="#robo344">cl_fmap_prev</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
2">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fget">
\r+<h2><a name="robo33
6">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fget">
\r Component Library: Flexi Map/cl_fmap_get</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_fmap_get</strong> function returns the map item associated with a key.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_get</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map,\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map,\r
IN const void* const p_key );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure from which to retrieve the\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure from which to retrieve the\r
item with the specified key.\r
\r
p_key\r
<span class="NOTES"><pre> <strong>cl_fmap_get</strong> does not remove the item from the flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo341">cl_fmap_remove</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo345">cl_fmap_remove</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
3">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fhead">
\r+<h2><a name="robo33
7">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fhead">
\r Component Library: Flexi Map/cl_fmap_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
value stored in a flexi map.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_head</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
- return( (<a href="#robo336">cl_fmap_item_t</a>*)p_map->nil.pool_item.list_item.p_next );\r
+ return( (<a href="#robo340">cl_fmap_item_t</a>*)p_map->nil.pool_item.list_item.p_next );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure whose item with the lowest key\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure whose item with the lowest key\r
is returned.\r
\r
RETURN VALUES\r
<span class="NOTES"><pre> <strong>cl_fmap_head</strong> does not remove the item from the map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo339">cl_fmap_next</a>, <a href="#robo340">cl_fmap_prev</a>, <a href="#robo331">cl_fmap_end</a>,\r
- <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo343">cl_fmap_next</a>, <a href="#robo344">cl_fmap_prev</a>, <a href="#robo335">cl_fmap_end</a>,\r
+ <a href="#robo340">cl_fmap_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
4">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5finit">
\r+<h2><a name="robo33
8">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5finit">
\r Component Library: Flexi Map/cl_fmap_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_fmap_init</strong>(\r
- IN <a href="#robo344">cl_fmap_t</a>* const p_map,\r
- IN <a href="#robo348">cl_pfn_fmap_cmp_t</a> pfn_compare );\r
+ IN <a href="#robo348">cl_fmap_t</a>* const p_map,\r
+ IN <a href="#robo352">cl_pfn_fmap_cmp_t</a> pfn_compare );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure to initialize.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure to initialize.\r
\r
pfn_compare\r
[in] Pointer to the compare function used to compare keys.\r
- See the <a href="#robo348">cl_pfn_fmap_cmp_t</a> function type declaration for details\r
+ See the <a href="#robo352">cl_pfn_fmap_cmp_t</a> function type declaration for details\r
about the callback function.\r
\r
RETURN VALUES\r
<span class="NOTES"><pre> Allows calling flexi map manipulation functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo335">cl_fmap_insert</a>, <a href="#robo341">cl_fmap_remove</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo339">cl_fmap_insert</a>, <a href="#robo345">cl_fmap_remove</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo33
5">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5finsert">
\r+<h2><a name="robo33
9">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5finsert">
\r Component Library: Flexi Map/cl_fmap_insert</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_fmap_insert</strong> function inserts a map item into a flexi map.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_insert</strong>(\r
- IN <a href="#robo344">cl_fmap_t</a>* const p_map,\r
+ IN <a href="#robo348">cl_fmap_t</a>* const p_map,\r
IN const void* const p_key,\r
- IN <a href="#robo336">cl_fmap_item_t</a>* const p_item );\r
+ IN <a href="#robo340">cl_fmap_item_t</a>* const p_item );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure into which to add the item.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure into which to add the item.\r
\r
p_key\r
[in] Pointer to the key value to assign to the item. Storage for\r
they are in use.\r
\r
p_item\r
- [in] Pointer to a <a href="#robo336">cl_fmap_item_t</a> stucture to insert into the flexi map.\r
+ [in] Pointer to a <a href="#robo340">cl_fmap_item_t</a> stucture to insert into the flexi map.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> Pointer to the item in the map with the specified key. If insertion\r
<span class="NOTES"><pre> Insertion operations may cause the flexi map to rebalance.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo341">cl_fmap_remove</a>, <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo345">cl_fmap_remove</a>, <a href="#robo340">cl_fmap_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
36">[Structures]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fitem5ft">
\r+<h2><a name="robo3
40">[Structures]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fitem5ft">
\r Component Library: Flexi Map/cl_fmap_item_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_fmap_item\r
{\r
/* Must be first to allow casting. */\r
- <a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a> pool_item;\r
+ <a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a> pool_item;\r
struct _cl_fmap_item *p_left;\r
struct _cl_fmap_item *p_right;\r
struct _cl_fmap_item *p_up;\r
\r
p_nil\r
Pointer to the map's NIL item, used as a terminator for leaves.\r
- The NIL sentinel is in the <a href="#robo344">cl_fmap_t</a> structure.\r
+ The NIL sentinel is in the <a href="#robo348">cl_fmap_t</a> structure.\r
\r
color\r
Indicates whether a node is red or black in the map.\r
\r
p_key\r
Pointer to the value that uniquely represents a node in a map. This\r
- pointer is set by calling <a href="#robo335">cl_fmap_insert</a> and can be retrieved by\r
- calling <a href="#robo337">cl_fmap_key</a>.\r
+ pointer is set by calling <a href="#robo339">cl_fmap_insert</a> and can be retrieved by\r
+ calling <a href="#robo341">cl_fmap_key</a>.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> None of the fields of this structure should be manipulated by users, as\r
The flexi map item is defined to be identical in layout as a map item.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo335">cl_fmap_insert</a>, <a href="#robo337">cl_fmap_key</a>, <a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a>, <a href="./cl_qlist_h.html#robo559">cl_list_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo339">cl_fmap_insert</a>, <a href="#robo341">cl_fmap_key</a>, <a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a>, <a href="./cl_qlist_h.html#robo563">cl_list_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
37">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fkey">
\r+<h2><a name="robo3
41">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fkey">
\r Component Library: Flexi Map/cl_fmap_key</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
#pragma warning (disable :4244)\r
CL_INLINE const void* CL_API\r
<strong>cl_fmap_key</strong>(\r
- IN const <a href="#robo336">cl_fmap_item_t</a>* const p_item )\r
+ IN const <a href="#robo340">cl_fmap_item_t</a>* const p_item )\r
{\r
CL_ASSERT( p_item );\r
return( p_item->p_key );\r
The key value should not be modified to insure proper flexi map operation.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> The key value is set in a call to <a href="#robo335">cl_fmap_insert</a>.\r
+<span class="NOTES"><pre> The key value is set in a call to <a href="#robo339">cl_fmap_insert</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo335">cl_fmap_insert</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo339">cl_fmap_insert</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
38">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fmerge">
\r+<h2><a name="robo3
42">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fmerge">
\r Component Library: Flexi Map/cl_fmap_merge</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_fmap_merge</strong>(\r
- OUT <a href="#robo344">cl_fmap_t</a>* const p_dest_map,\r
- IN OUT <a href="#robo344">cl_fmap_t</a>* const p_src_map );\r
+ OUT <a href="#robo348">cl_fmap_t</a>* const p_dest_map,\r
+ IN OUT <a href="#robo348">cl_fmap_t</a>* const p_src_map );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_dest_map\r
- [out] Pointer to a <a href="#robo344">cl_fmap_t</a> structure to which items should be added.\r
+ [out] Pointer to a <a href="#robo348">cl_fmap_t</a> structure to which items should be added.\r
\r
p_src_map\r
- [in/out] Pointer to a <a href="#robo344">cl_fmap_t</a> structure whose items to add\r
+ [in/out] Pointer to a <a href="#robo348">cl_fmap_t</a> structure whose items to add\r
to p_dest_map.\r
\r
RETURN VALUES\r
contains all duplicate items.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo330">cl_fmap_delta</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo334">cl_fmap_delta</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
39">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fnext">
\r+<h2><a name="robo3
43">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fnext">
\r Component Library: Flexi Map/cl_fmap_next</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
key value than a specified map item.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_next</strong>(\r
- IN const <a href="#robo336">cl_fmap_item_t</a>* const p_item )\r
+ IN const <a href="#robo340">cl_fmap_item_t</a>* const p_item )\r
{\r
CL_ASSERT( p_item );\r
- return( (<a href="#robo336">cl_fmap_item_t</a>*)p_item->pool_item.list_item.p_next );\r
+ return( (<a href="#robo340">cl_fmap_item_t</a>*)p_item->pool_item.list_item.p_next );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
the flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo333">cl_fmap_head</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo340">cl_fmap_prev</a>, <a href="#robo331">cl_fmap_end</a>,\r
- <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo337">cl_fmap_head</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo344">cl_fmap_prev</a>, <a href="#robo335">cl_fmap_end</a>,\r
+ <a href="#robo340">cl_fmap_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
0">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fprev">
\r+<h2><a name="robo34
4">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fprev">
\r Component Library: Flexi Map/cl_fmap_prev</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
key value than a precified map item.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_prev</strong>(\r
- IN const <a href="#robo336">cl_fmap_item_t</a>* const p_item )\r
+ IN const <a href="#robo340">cl_fmap_item_t</a>* const p_item )\r
{\r
CL_ASSERT( p_item );\r
- return( (<a href="#robo336">cl_fmap_item_t</a>*)p_item->pool_item.list_item.p_prev );\r
+ return( (<a href="#robo340">cl_fmap_item_t</a>*)p_item->pool_item.list_item.p_prev );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
the flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo333">cl_fmap_head</a>, <a href="#robo345">cl_fmap_tail</a>, <a href="#robo339">cl_fmap_next</a>, <a href="#robo331">cl_fmap_end</a>,\r
- <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo337">cl_fmap_head</a>, <a href="#robo349">cl_fmap_tail</a>, <a href="#robo343">cl_fmap_next</a>, <a href="#robo335">cl_fmap_end</a>,\r
+ <a href="#robo340">cl_fmap_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
1">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove">
\r+<h2><a name="robo34
5">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove">
\r Component Library: Flexi Map/cl_fmap_remove</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
from a flexi map.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_remove</strong>(\r
- IN <a href="#robo344">cl_fmap_t</a>* const p_map,\r
+ IN <a href="#robo348">cl_fmap_t</a>* const p_map,\r
IN const void* const p_key );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure from which to remove the item\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure from which to remove the item\r
with the specified key.\r
\r
p_key\r
flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo343">cl_fmap_remove_item</a>, <a href="#robo342">cl_fmap_remove_all</a>, <a href="#robo335">cl_fmap_insert</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo347">cl_fmap_remove_item</a>, <a href="#robo346">cl_fmap_remove_all</a>, <a href="#robo339">cl_fmap_insert</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
2">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove5fall">
\r+<h2><a name="robo34
6">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove5fall">
\r Component Library: Flexi Map/cl_fmap_remove_all</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void CL_API\r
<strong>cl_fmap_remove_all</strong>(\r
- IN <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure to empty.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure to empty.\r
\r
RETURN VALUES\r
This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo341">cl_fmap_remove</a>, <a href="#robo343">cl_fmap_remove_item</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo345">cl_fmap_remove</a>, <a href="#robo347">cl_fmap_remove_item</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
3">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove5fitem">
\r+<h2><a name="robo34
7">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5fremove5fitem">
\r Component Library: Flexi Map/cl_fmap_remove_item</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_fmap_remove_item</strong>(\r
- IN <a href="#robo344">cl_fmap_t</a>* const p_map,\r
- IN <a href="#robo336">cl_fmap_item_t</a>* const p_item );\r
+ IN <a href="#robo348">cl_fmap_t</a>* const p_map,\r
+ IN <a href="#robo340">cl_fmap_item_t</a>* const p_item );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_item\r
<span class="NOTES"><pre> Removes the map item pointed to by p_item from its flexi map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo341">cl_fmap_remove</a>, <a href="#robo342">cl_fmap_remove_all</a>, <a href="#robo335">cl_fmap_insert</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo345">cl_fmap_remove</a>, <a href="#robo346">cl_fmap_remove_all</a>, <a href="#robo339">cl_fmap_insert</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
4">[Structures]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5ft">
\r+<h2><a name="robo34
8">[Structures]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5ft">
\r Component Library: Flexi Map/cl_fmap_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_fmap\r
{\r
- <a href="#robo336">cl_fmap_item_t</a> root;\r
- <a href="#robo336">cl_fmap_item_t</a> nil;\r
+ <a href="#robo340">cl_fmap_item_t</a> root;\r
+ <a href="#robo340">cl_fmap_item_t</a> nil;\r
cl_state_t state;\r
size_t count;\r
- <a href="#robo348">cl_pfn_fmap_cmp_t</a> pfn_compare;\r
+ <a href="#robo352">cl_pfn_fmap_cmp_t</a> pfn_compare;\r
\r
} <strong>cl_fmap_t</strong>;\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> root\r
- <a href="./cl_map_h.html#robo17">Map</a> item that serves as root of the map. The root is set up to\r
+ <a href="./cl_map_h.html#robo18">Map</a> item that serves as root of the map. The root is set up to\r
always have itself as parent. The left pointer is set to point to\r
the item at the root.\r
\r
nil\r
- <a href="./cl_map_h.html#robo17">Map</a> item that serves as terminator for all leaves, as well as providing\r
+ <a href="./cl_map_h.html#robo18">Map</a> item that serves as terminator for all leaves, as well as providing\r
the list item used as quick list for storing map items in a list for\r
faster traversal.\r
\r
items in the map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo348">cl_pfn_fmap_cmp_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo352">cl_pfn_fmap_cmp_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo34
5">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5ftail">
\r+<h2><a name="robo34
9">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5ffmap5ftail">
\r Component Library: Flexi Map/cl_fmap_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
value stored in a flexi map.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo336">cl_fmap_item_t</a>* CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="#robo340">cl_fmap_item_t</a>* CL_API\r
<strong>cl_fmap_tail</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
- return( (<a href="#robo336">cl_fmap_item_t</a>*)p_map->nil.pool_item.list_item.p_prev );\r
+ return( (<a href="#robo340">cl_fmap_item_t</a>*)p_map->nil.pool_item.list_item.p_prev );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure whose item with the highest key\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure whose item with the highest key\r
is returned.\r
\r
RETURN VALUES\r
Pointer to the map end if the flexi map was empty.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> <a href="#robo331">cl_fmap_end</a> does not remove the item from the map.\r
+<span class="NOTES"><pre> <a href="#robo335">cl_fmap_end</a> does not remove the item from the map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo333">cl_fmap_head</a>, <a href="#robo339">cl_fmap_next</a>, <a href="#robo340">cl_fmap_prev</a>, <a href="#robo331">cl_fmap_end</a>,\r
- <a href="#robo336">cl_fmap_item_t</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo337">cl_fmap_head</a>, <a href="#robo343">cl_fmap_next</a>, <a href="#robo344">cl_fmap_prev</a>, <a href="#robo335">cl_fmap_end</a>,\r
+ <a href="#robo340">cl_fmap_item_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
46">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5fis5ffmap5fempty">
\r+<h2><a name="robo3
50">[Functions]<a name="Component20Library3a20Flexi20Map2fcl5fis5ffmap5fempty">
\r Component Library: Flexi Map/cl_is_fmap_empty</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_fmap_empty</strong>(\r
- IN const <a href="#robo344">cl_fmap_t</a>* const p_map )\r
+ IN const <a href="#robo348">cl_fmap_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
CL_ASSERT( p_map->state == CL_INITIALIZED );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo344">cl_fmap_t</a> structure to test for emptiness.\r
+ [in] Pointer to a <a href="#robo348">cl_fmap_t</a> structure to test for emptiness.\r
\r
RETURN VALUES\r
TRUE if the flexi map is empty.\r
FALSE otherwise.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo329">cl_fmap_count</a>, <a href="#robo342">cl_fmap_remove_all</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo333">cl_fmap_count</a>, <a href="#robo346">cl_fmap_remove_all</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
47">[Definitions]<a name="Component20Library3a20Flexi20Map2fcl5fpfn5ffmap5fapply5ft">
\r+<h2><a name="robo3
51">[Definitions]<a name="Component20Library3a20Flexi20Map2fcl5fpfn5ffmap5fapply5ft">
\r Component Library: Flexi Map/cl_pfn_fmap_apply_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef void\r
(CL_API *<strong>cl_pfn_fmap_apply_t</strong>)(\r
- IN <a href="#robo336">cl_fmap_item_t</a>* const p_map_item,\r
+ IN <a href="#robo340">cl_fmap_item_t</a>* const p_map_item,\r
IN void* context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map_item\r
- [in] Pointer to a <a href="#robo336">cl_fmap_item_t</a> structure.\r
+ [in] Pointer to a <a href="#robo340">cl_fmap_item_t</a> structure.\r
\r
context\r
[in] Value passed to the callback function.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for the\r
- function provided by users as a parameter to the <a href="#robo328">cl_fmap_apply_func</a>\r
+ function provided by users as a parameter to the <a href="#robo332">cl_fmap_apply_func</a>\r
function.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo328">cl_fmap_apply_func</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo332">cl_fmap_apply_func</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
48">[Definitions]<a name="Component20Library3a20Flexi20Map2fcl5fpfn5ffmap5fcmp5ft">
\r+<h2><a name="robo3
52">[Definitions]<a name="Component20Library3a20Flexi20Map2fcl5fpfn5ffmap5fcmp5ft">
\r Component Library: Flexi Map/cl_pfn_fmap_cmp_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for the\r
- function provided by users as a parameter to the <a href="#robo334">cl_fmap_init</a> function.\r
+ function provided by users as a parameter to the <a href="#robo338">cl_fmap_init</a> function.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo17">Map</a>, <a href="#robo334">cl_fmap_init</a>\r
+<span class="SEE_ALSO"><pre> Flexi <a href="./cl_map_h.html#robo18">Map</a>, <a href="#robo338">cl_fmap_init</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_ioctl_h.html</title>\r
+<title>./inc_docs/complib/cl_ioctl_h.html</title>\r
<!-- Source: ./inc/complib/cl_ioctl.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_ioctl.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_ioctl.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:39\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
3">[Modules]<a name="Component20Library2fIOCTL20Object">
\r+<h2><a name="robo1
4">[Modules]<a name="Component20Library2fIOCTL20Object">
\r Component Library/IOCTL Object</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
-<span class="NAME"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>\r
+<span class="NAME"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
<span class="DESCRIPTION"><pre> The IOCTL object provides functionality for handling IOCTL requests.\r
\r
The IOCTL object is only available in kernel mode and provides\r
functionality for accessing information about IO requests initiated\r
- by a user-mode application. The <a href="#robo362">IOCTL_CODE</a> macro is used in both\r
+ by a user-mode application. The <a href="#robo366">IOCTL_CODE</a> macro is used in both\r
user and kernel mode to initiate and dispatch IOCTL requests, respectively.\r
\r
In Linux, in order for the IOCTL object to be used, requests must be\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Structures:\r
- <a href="#robo352">cl_ioctl_handle_t</a>\r
+ <a href="#robo356">cl_ioctl_handle_t</a>\r
\r
Callbacks:\r
- <a href="#robo361">cl_pfn_ioctl_handler_t</a>\r
+ <a href="#robo365">cl_pfn_ioctl_handler_t</a>\r
\r
Control Code Generation\r
- <a href="#robo362">IOCTL_CODE</a>\r
+ <a href="#robo366">IOCTL_CODE</a>\r
\r
Kernel Mode Access\r
- <a href="#robo357">cl_ioctl_process</a>\r
- <a href="#robo350">cl_ioctl_complete</a>\r
- <a href="#robo360">cl_ioctl_type</a>\r
- <a href="#robo349">cl_ioctl_cmd</a>\r
- <a href="#robo351">cl_ioctl_ctl_code</a>\r
- <a href="#robo353">cl_ioctl_in_buf</a>\r
- <a href="#robo354">cl_ioctl_in_size</a>\r
- <a href="#robo355">cl_ioctl_out_buf</a>\r
- <a href="#robo356">cl_ioctl_out_size</a>\r
+ <a href="#robo361">cl_ioctl_process</a>\r
+ <a href="#robo354">cl_ioctl_complete</a>\r
+ <a href="#robo364">cl_ioctl_type</a>\r
+ <a href="#robo353">cl_ioctl_cmd</a>\r
+ <a href="#robo355">cl_ioctl_ctl_code</a>\r
+ <a href="#robo357">cl_ioctl_in_buf</a>\r
+ <a href="#robo358">cl_ioctl_in_size</a>\r
+ <a href="#robo359">cl_ioctl_out_buf</a>\r
+ <a href="#robo360">cl_ioctl_out_size</a>\r
\r
User Mode Access\r
- <a href="#robo358">cl_ioctl_request</a>\r
- <a href="#robo359">cl_ioctl_result</a>\r
+ <a href="#robo362">cl_ioctl_request</a>\r
+ <a href="#robo363">cl_ioctl_result</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
49">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fcmd">
\r+<h2><a name="robo3
53">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fcmd">
\r Component Library: IOCTL Object/cl_ioctl_cmd</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT uint16_t CL_API\r
<strong>cl_ioctl_cmd</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
<span class="NOTES"><pre> The <strong>cl_ioctl_cmd</strong> function is only available in the kernel.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo360">cl_ioctl_type</a>, <a href="#robo351">cl_ioctl_ctl_code</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo364">cl_ioctl_type</a>, <a href="#robo355">cl_ioctl_ctl_code</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
0">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fcomplete">
\r+<h2><a name="robo35
4">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fcomplete">
\r Component Library: IOCTL Object/cl_ioctl_complete</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_ioctl_complete</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl,\r
- IN <a href="./cl_types_h.html#robo309">cl_status_t</a> io_status,\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl,\r
+ IN <a href="./cl_types_h.html#robo313">cl_status_t</a> io_status,\r
IN size_t ret_bytes );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo357">cl_ioctl_process</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo361">cl_ioctl_process</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
1">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fctl5fcode">
\r+<h2><a name="robo35
5">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fctl5fcode">
\r Component Library: IOCTL Object/cl_ioctl_ctl_code</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT uint32_t CL_API\r
<strong>cl_ioctl_ctl_code</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
<span class="NOTES"><pre> The <strong>cl_ioctl_ctl_code</strong> function is only available in the kernel.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo360">cl_ioctl_type</a>, <a href="#robo349">cl_ioctl_cmd</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo364">cl_ioctl_type</a>, <a href="#robo353">cl_ioctl_cmd</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
2">[Definitions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fhandle5ft">
\r+<h2><a name="robo35
6">[Definitions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fhandle5ft">
\r Component Library: IOCTL Object/cl_ioctl_handle_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
varies from environment to environment.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo360">cl_ioctl_type</a>, <a href="#robo349">cl_ioctl_cmd</a>, <a href="#robo353">cl_ioctl_in_buf</a>,\r
- <a href="#robo354">cl_ioctl_in_size</a>, <a href="#robo355">cl_ioctl_out_buf</a>, <a href="#robo356">cl_ioctl_out_size</a>,\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo364">cl_ioctl_type</a>, <a href="#robo353">cl_ioctl_cmd</a>, <a href="#robo357">cl_ioctl_in_buf</a>,\r
+ <a href="#robo358">cl_ioctl_in_size</a>, <a href="#robo359">cl_ioctl_out_buf</a>, <a href="#robo360">cl_ioctl_out_size</a>,\r
cl_ioctl_set_status, cl_ioctl_set_ret_bytes\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
3">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fin5fbuf">
\r+<h2><a name="robo35
7">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fin5fbuf">
\r Component Library: IOCTL Object/cl_ioctl_in_buf</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void* CL_API\r
<strong>cl_ioctl_in_buf</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
returned pointer points to the MDL describing the input buffer.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo354">cl_ioctl_in_size</a>,\r
- <a href="#robo355">cl_ioctl_out_buf</a>, <a href="#robo356">cl_ioctl_out_size</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo358">cl_ioctl_in_size</a>,\r
+ <a href="#robo359">cl_ioctl_out_buf</a>, <a href="#robo360">cl_ioctl_out_size</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
4">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fin5fsize">
\r+<h2><a name="robo35
8">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fin5fsize">
\r Component Library: IOCTL Object/cl_ioctl_in_size</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT ULONG CL_API\r
<strong>cl_ioctl_in_size</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
<span class="NOTES"><pre> The <strong>cl_ioctl_in_size</strong> function is only available in the kernel.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo353">cl_ioctl_in_buf</a>,\r
- <a href="#robo355">cl_ioctl_out_buf</a>, <a href="#robo356">cl_ioctl_out_size</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo357">cl_ioctl_in_buf</a>,\r
+ <a href="#robo359">cl_ioctl_out_buf</a>, <a href="#robo360">cl_ioctl_out_size</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo35
5">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fout5fbuf">
\r+<h2><a name="robo35
9">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fout5fbuf">
\r Component Library: IOCTL Object/cl_ioctl_out_buf</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void* CL_API\r
<strong>cl_ioctl_out_buf</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
the input buffer.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo356">cl_ioctl_out_size</a>,\r
- <a href="#robo353">cl_ioctl_in_buf</a>, <a href="#robo354">cl_ioctl_in_size</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo360">cl_ioctl_out_size</a>,\r
+ <a href="#robo357">cl_ioctl_in_buf</a>, <a href="#robo358">cl_ioctl_in_size</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
56">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fout5fsize">
\r+<h2><a name="robo3
60">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fout5fsize">
\r Component Library: IOCTL Object/cl_ioctl_out_size</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT ULONG CL_API\r
<strong>cl_ioctl_out_size</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
<span class="NOTES"><pre> The <strong>cl_ioctl_out_size</strong> function is only available in the kernel.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo355">cl_ioctl_out_buf</a>,\r
- <a href="#robo353">cl_ioctl_in_buf</a>, <a href="#robo354">cl_ioctl_in_size</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo359">cl_ioctl_out_buf</a>,\r
+ <a href="#robo357">cl_ioctl_in_buf</a>, <a href="#robo358">cl_ioctl_in_size</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
57">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fprocess">
\r+<h2><a name="robo3
61">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fprocess">
\r Component Library: IOCTL Object/cl_ioctl_process</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_ioctl_process</strong> function unpacks information initiated by a call to\r
- <a href="#robo358">cl_ioctl_request</a> function and invokes a user-supplied callback.\r
+ <a href="#robo362">cl_ioctl_request</a> function and invokes a user-supplied callback.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_ioctl_process</strong>(\r
IN void *p_ioctl,\r
- IN <a href="#robo361">cl_pfn_ioctl_handler_t</a> pfn_ioctl_handler,\r
+ IN <a href="#robo365">cl_pfn_ioctl_handler_t</a> pfn_ioctl_handler,\r
IN void *context_1,\r
IN void *context_2 );\r
</pre>\r
Other values to indicate various failures.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Users must call <a href="#robo350">cl_ioctl_complete</a> from within the handler if completing\r
+<span class="NOTES"><pre> Users must call <a href="#robo354">cl_ioctl_complete</a> from within the handler if completing\r
the IOCTL request synchronously. If the IOCTL request's control code is\r
invalid, the handler should return CL_INVALID_REQUEST.\r
\r
parameter of the IOCTL entry point instead of a copy.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo361">cl_pfn_ioctl_handler_t</a>, <a href="#robo350">cl_ioctl_complete</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo365">cl_pfn_ioctl_handler_t</a>, <a href="#robo354">cl_ioctl_complete</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
58">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5frequest">
\r+<h2><a name="robo3
62">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5frequest">
\r Component Library: IOCTL Object/cl_ioctl_request</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
requests to a device.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_ioctl_request</strong>(\r
IN void *h_dev,\r
IN uint32_t ioctl_code,\r
exclusive of the p_ret_bytes parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo359">cl_ioctl_result</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo363">cl_ioctl_result</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
59">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fresult">
\r+<h2><a name="robo3
63">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5fresult">
\r Component Library: IOCTL Object/cl_ioctl_result</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> Checks the status of an asynchronous IOCTL request.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_ioctl_result</strong>(\r
IN void *h_dev,\r
IN void *p_async_info,\r
[in] For platforms that support asynchronous I/O, supplies a pointer\r
to that platform's async I/O structure, if any. For Windows, this\r
is a pointer to an OVERLAPPED structure. This must be the same\r
- as that provided in the <a href="#robo358">cl_ioctl_request</a> function.\r
+ as that provided in the <a href="#robo362">cl_ioctl_request</a> function.\r
\r
p_ret_bytes\r
[out] Number of bytes written to the output buffer.\r
Other status values to indicate errors.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo358">cl_ioctl_request</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo362">cl_ioctl_request</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
0">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5ftype">
\r+<h2><a name="robo36
4">[Functions]<a name="Component20Library3a20IOCTL20Object2fcl5fioctl5ftype">
\r Component Library: IOCTL Object/cl_ioctl_type</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT uint16_t CL_API\r
<strong>cl_ioctl_type</strong>(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl );\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> h_ioctl\r
<span class="NOTES"><pre> The <strong>cl_ioctl_type</strong> function is only available in the kernel.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo349">cl_ioctl_cmd</a>, <a href="#robo351">cl_ioctl_ctl_code</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo353">cl_ioctl_cmd</a>, <a href="#robo355">cl_ioctl_ctl_code</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
1">[Definitions]<a name="Component20Library3a20IOCTL20Object2fcl5fpfn5fioctl5fhandler5ft">
\r+<h2><a name="robo36
5">[Definitions]<a name="Component20Library3a20IOCTL20Object2fcl5fpfn5fioctl5fhandler5ft">
\r Component Library: IOCTL Object/cl_pfn_ioctl_handler_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
</span><p><strong>DESCRIPTION</strong></p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_pfn_ioctl_handler_t</strong> function type defines the prototype for\r
IOCTL handlers used when handling IOCTL requests initiated by\r
- <a href="#robo358">cl_ioctl_request</a>.\r
+ <a href="#robo362">cl_ioctl_request</a>.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo309">cl_status_t</a>\r
+<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo313">cl_status_t</a>\r
(CL_API *<strong>cl_pfn_ioctl_handler_t</strong>)(\r
- IN <a href="#robo352">cl_ioctl_handle_t</a> h_ioctl,\r
+ IN <a href="#robo356">cl_ioctl_handle_t</a> h_ioctl,\r
IN void *context_1,\r
IN void *context_2 );\r
</pre>\r
[in] Handle to the IOCTL request.\r
\r
context_1\r
- [in] First context parameters, as provided to <a href="#robo357">cl_ioctl_process</a>.\r
+ [in] First context parameters, as provided to <a href="#robo361">cl_ioctl_process</a>.\r
\r
context_2\r
- [in] Second context parameters, as provided to <a href="#robo357">cl_ioctl_process</a>.\r
+ [in] Second context parameters, as provided to <a href="#robo361">cl_ioctl_process</a>.\r
\r
RETURN VALUES\r
CL_SUCCESS if the IOCTL was completed successfully.\r
status in the output buffer.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, <a href="#robo352">cl_ioctl_handle_t</a>, <a href="#robo357">cl_ioctl_process</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, <a href="#robo356">cl_ioctl_handle_t</a>, <a href="#robo361">cl_ioctl_process</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
2">[Definitions]<a name="Component20Library3a20IOCTL20Object2fIOCTL5fCODE">
\r+<h2><a name="robo36
6">[Definitions]<a name="Component20Library3a20IOCTL20Object2fIOCTL5fCODE">
\r Component Library: IOCTL Object/IOCTL_CODE</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
result in FILE_ANY_ACCESS and METHOD_BUFFERED being specified.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo18">Object</a>, cl_dev_ioctl, <a href="#robo360">cl_ioctl_type</a>, <a href="#robo349">cl_ioctl_cmd</a>\r
+<span class="SEE_ALSO"><pre> IOCTL <a href="./cl_obj_h.html#robo19">Object</a>, cl_dev_ioctl, <a href="#robo364">cl_ioctl_type</a>, <a href="#robo353">cl_ioctl_cmd</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_irqlock_h.html</title>\r
+<title>./inc_docs/complib/cl_irqlock_h.html</title>\r
<!-- Source: ./inc/complib/cl_irqlock.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_irqlock.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_irqlock.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:38\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
4">[Modules]<a name="Component20Library2fIrqlock">
\r+<h2><a name="robo1
5">[Modules]<a name="Component20Library2fIrqlock">
\r Component Library/Irqlock</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> <strong>Irqlock</strong>\r
</pre>\r
cl_irqlock_t\r
\r
Initialization:\r
- <a href="#robo364">cl_irqlock_construct</a>, <a href="#robo366">cl_irqlock_init</a>, <a href="#robo365">cl_irqlock_destroy</a>\r
+ <a href="#robo368">cl_irqlock_construct</a>, <a href="#robo370">cl_irqlock_init</a>, <a href="#robo369">cl_irqlock_destroy</a>\r
\r
Manipulation\r
- <a href="#robo363">cl_irqlock_acquire</a>, <a href="#robo367">cl_irqlock_release</a>\r
+ <a href="#robo367">cl_irqlock_acquire</a>, <a href="#robo371">cl_irqlock_release</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
3">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5facquire">
\r+<h2><a name="robo36
7">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5facquire">
\r Component Library: Irqlock/cl_irqlock_acquire</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo14">Irqlock</a>, <a href="#robo367">cl_irqlock_release</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo15">Irqlock</a>, <a href="#robo371">cl_irqlock_release</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
4">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5fconstruct">
\r+<h2><a name="robo36
8">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5fconstruct">
\r Component Library: Irqlock/cl_irqlock_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="#robo365">cl_irqlock_destroy</a> without first calling \r
- <a href="#robo366">cl_irqlock_init</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="#robo369">cl_irqlock_destroy</a> without first calling \r
+ <a href="#robo370">cl_irqlock_init</a>.\r
\r
Calling <strong>cl_irqlock_construct</strong> is a prerequisite to calling any other\r
- IRQ lock function except <a href="#robo366">cl_irqlock_init</a>.\r
+ IRQ lock function except <a href="#robo370">cl_irqlock_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo14">Irqlock</a>, <a href="#robo366">cl_irqlock_init</a>, <a href="#robo365">cl_irqlock_destroy</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo15">Irqlock</a>, <a href="#robo370">cl_irqlock_init</a>, <a href="#robo369">cl_irqlock_destroy</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo36
5">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5fdestroy">
\r+<h2><a name="robo36
9">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5fdestroy">
\r Component Library: Irqlock/cl_irqlock_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> Performs any necessary cleanup of a IRQ lock. This function must only \r
- be called if either <a href="#robo364">cl_irqlock_construct</a> or <a href="#robo366">cl_irqlock_init</a> has been \r
+ be called if either <a href="#robo368">cl_irqlock_construct</a> or <a href="#robo370">cl_irqlock_init</a> has been \r
called.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo14">Irqlock</a>, <a href="#robo364">cl_irqlock_construct</a>, <a href="#robo366">cl_irqlock_init</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo15">Irqlock</a>, <a href="#robo368">cl_irqlock_construct</a>, <a href="#robo370">cl_irqlock_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
66">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5finit">
\r+<h2><a name="robo3
70">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5finit">
\r Component Library: Irqlock/cl_irqlock_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_irqlock_init</strong> function initializes a IRQ lock for use.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_irqlock_init</strong>( \r
IN cl_irqlock_t* const p_irqlock,\r
IN cl_interrupt_t* const p_interrupt );\r
CL_SUCCESS if initialization succeeded.\r
\r
CL_ERROR if initialization failed. Callers should call \r
- <a href="#robo365">cl_irqlock_destroy</a> to clean up any resources allocated during \r
+ <a href="#robo369">cl_irqlock_destroy</a> to clean up any resources allocated during \r
initialization.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> Initialize the IRQ lock structure. Allows calling cl_irqlock_aquire \r
- and <a href="#robo367">cl_irqlock_release</a>.\r
+ and <a href="#robo371">cl_irqlock_release</a>.\r
\r
In Linux, the p_interrupt parameter is currently ignored.\r
\r
the value of which is supplied by a call to IoConnectInterrupt.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo14">Irqlock</a>, <a href="#robo364">cl_irqlock_construct</a>, <a href="#robo365">cl_irqlock_destroy</a>, \r
- <a href="#robo363">cl_irqlock_acquire</a>, <a href="#robo367">cl_irqlock_release</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo15">Irqlock</a>, <a href="#robo368">cl_irqlock_construct</a>, <a href="#robo369">cl_irqlock_destroy</a>, \r
+ <a href="#robo367">cl_irqlock_acquire</a>, <a href="#robo371">cl_irqlock_release</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
67">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5frelease">
\r+<h2><a name="robo3
71">[Functions]<a name="Component20Library3a20Irqlock2fcl5firqlock5frelease">
\r Component Library: Irqlock/cl_irqlock_release</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Releases a IRQ lock after a call to <a href="#robo363">cl_irqlock_acquire</a>.\r
+<span class="NOTES"><pre> Releases a IRQ lock after a call to <a href="#robo367">cl_irqlock_acquire</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo14">Irqlock</a>, <a href="#robo363">cl_irqlock_acquire</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo15">Irqlock</a>, <a href="#robo367">cl_irqlock_acquire</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_list_h.html</title>\r
+<title>./inc_docs/complib/cl_list_h.html</title>\r
<!-- Source: ./inc/complib/cl_list.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_list.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_list.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:38\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
5">[Modules]<a name="Component20Library2fList">
\r+<h2><a name="robo1
6">[Modules]<a name="Component20Library2fList">
\r Component Library/List</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> <strong>List</strong>\r
</pre>\r
<span class="DESCRIPTION"><pre> <strong>List</strong> stores objects in a doubly linked list.\r
\r
Unlike quick list, users pass pointers to the object being stored, rather\r
- than to a <a href="./cl_qlist_h.html#robo559">cl_list_item_t</a> structure. Insertion operations on a list can\r
+ than to a <a href="./cl_qlist_h.html#robo563">cl_list_item_t</a> structure. Insertion operations on a list can\r
fail, and callers should trap for such failures.\r
\r
Use quick list in situations where insertion failures cannot be tolerated.\r
\r
<strong>List</strong> is not thread safe, and users must provide serialization.\r
\r
- The list functions operates on a <a href="#robo395">cl_list_t</a> structure which should be\r
+ The list functions operates on a <a href="#robo399">cl_list_t</a> structure which should be\r
treated as opaque and should be manipulated only through the provided\r
functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Types:\r
- <a href="#robo386">cl_list_iterator_t</a>\r
+ <a href="#robo390">cl_list_iterator_t</a>\r
\r
Structures:\r
- <a href="#robo395">cl_list_t</a>\r
+ <a href="#robo399">cl_list_t</a>\r
\r
Callbacks:\r
- <a href="#robo397">cl_pfn_list_apply_t</a>, <a href="#robo398">cl_pfn_list_find_t</a>\r
+ <a href="#robo401">cl_pfn_list_apply_t</a>, <a href="#robo402">cl_pfn_list_find_t</a>\r
\r
Initialization/Destruction:\r
- <a href="#robo372">cl_list_construct</a>, <a href="#robo379">cl_list_init</a>, <a href="#robo374">cl_list_destroy</a>\r
+ <a href="#robo376">cl_list_construct</a>, <a href="#robo383">cl_list_init</a>, <a href="#robo378">cl_list_destroy</a>\r
\r
Iteration:\r
- <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>,\r
- <a href="#robo375">cl_list_end</a>\r
+ <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>,\r
+ <a href="#robo379">cl_list_end</a>\r
\r
Manipulation:\r
- <a href="#robo382">cl_list_insert_head</a>, <a href="#robo385">cl_list_insert_tail</a>,\r
- <a href="#robo380">cl_list_insert_array_head</a>, <a href="#robo381">cl_list_insert_array_tail</a>,\r
- <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo383">cl_list_insert_next</a>,\r
- <a href="#robo391">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_tail</a>,\r
- <a href="#robo393">cl_list_remove_object</a>, <a href="#robo392">cl_list_remove_item</a>, <a href="#robo390">cl_list_remove_all</a>\r
+ <a href="#robo386">cl_list_insert_head</a>, <a href="#robo389">cl_list_insert_tail</a>,\r
+ <a href="#robo384">cl_list_insert_array_head</a>, <a href="#robo385">cl_list_insert_array_tail</a>,\r
+ <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo387">cl_list_insert_next</a>,\r
+ <a href="#robo395">cl_list_remove_head</a>, <a href="#robo398">cl_list_remove_tail</a>,\r
+ <a href="#robo397">cl_list_remove_object</a>, <a href="#robo396">cl_list_remove_item</a>, <a href="#robo394">cl_list_remove_all</a>\r
\r
Search:\r
- <a href="#robo370">cl_is_object_in_list</a>, <a href="#robo376">cl_list_find_from_head</a>, <a href="#robo377">cl_list_find_from_tail</a>,\r
- <a href="#robo371">cl_list_apply_func</a>\r
+ <a href="#robo374">cl_is_object_in_list</a>, <a href="#robo380">cl_list_find_from_head</a>, <a href="#robo381">cl_list_find_from_tail</a>,\r
+ <a href="#robo375">cl_list_apply_func</a>\r
\r
Attributes:\r
- <a href="#robo373">cl_list_count</a>, <a href="#robo368">cl_is_list_empty</a>, <a href="#robo369">cl_is_list_inited</a>\r
+ <a href="#robo377">cl_list_count</a>, <a href="#robo372">cl_is_list_empty</a>, <a href="#robo373">cl_is_list_inited</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
68">[Functions]<a name="Component20Library3a20List2fcl5fis5flist5fempty">
\r+<h2><a name="robo3
72">[Functions]<a name="Component20Library3a20List2fcl5fis5flist5fempty">
\r Component Library: List/cl_is_list_empty</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_list_empty</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
- return( <a href="./cl_qlist_h.html#robo558">cl_is_qlist_empty</a>( &p_list->list ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ return( <a href="./cl_qlist_h.html#robo562">cl_is_qlist_empty</a>( &p_list->list ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure.\r
\r
RETURN VALUES\r
TRUE if the specified list is empty.\r
FALSE otherwise.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo373">cl_list_count</a>, <a href="#robo390">cl_list_remove_all</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo377">cl_list_count</a>, <a href="#robo394">cl_list_remove_all</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
69">[Functions]<a name="Component20Library3a20List2fcl5fis5flist5finited">
\r+<h2><a name="robo3
73">[Functions]<a name="Component20Library3a20List2fcl5fis5flist5finited">
\r Component Library: List/cl_is_list_inited</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_list_inited</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
/* CL_ASSERT that a non-null pointer is provided. */\r
CL_ASSERT( p_list );\r
* The pool is the last thing initialized. If it is initialized, the\r
* list is initialized too.\r
*/\r
- return( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ return( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure whose initilization state\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure whose initilization state\r
to check.\r
\r
RETURN VALUES\r
member functions is appropriate.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
0">[Functions]<a name="Component20Library3a20List2fcl5fis5fobject5fin5flist">
\r+<h2><a name="robo37
4">[Functions]<a name="Component20Library3a20List2fcl5fis5fobject5fin5flist">
\r Component Library: List/cl_is_object_in_list</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT boolean_t CL_API\r
<strong>cl_is_object_in_list</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_object );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure in which to look for the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure in which to look for the object.\r
\r
p_object\r
[in] Pointer to an object stored in a list.\r
FALSE otherwise.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
1">[Functions]<a name="Component20Library3a20List2fcl5flist5fapply5ffunc">
\r+<h2><a name="robo37
5">[Functions]<a name="Component20Library3a20List2fcl5flist5fapply5ffunc">
\r Component Library: List/cl_list_apply_func</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_list_apply_func</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN <a href="#robo397">cl_pfn_list_apply_t</a> pfn_func,\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo401">cl_pfn_list_apply_t</a> pfn_func,\r
IN const void* const context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure to iterate.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure to iterate.\r
\r
pfn_func\r
[in] Function invoked for every item in a list.\r
- See the <a href="#robo397">cl_pfn_list_apply_t</a> function type declaration for details\r
+ See the <a href="#robo401">cl_pfn_list_apply_t</a> function type declaration for details\r
about the callback function.\r
\r
context\r
would corrupt the list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo376">cl_list_find_from_head</a>, <a href="#robo377">cl_list_find_from_tail</a>,\r
- <a href="#robo397">cl_pfn_list_apply_t</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo380">cl_list_find_from_head</a>, <a href="#robo381">cl_list_find_from_tail</a>,\r
+ <a href="#robo401">cl_pfn_list_apply_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
2">[Functions]<a name="Component20Library3a20List2fcl5flist5fconstruct">
\r+<h2><a name="robo37
6">[Functions]<a name="Component20Library3a20List2fcl5flist5fconstruct">
\r Component Library: List/cl_list_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_list_construct</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list );\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to <a href="#robo395">cl_list_t</a> object whose state to initialize.\r
+ [in] Pointer to <a href="#robo399">cl_list_t</a> object whose state to initialize.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="#robo379">cl_list_init</a>, <a href="#robo374">cl_list_destroy</a> and <a href="#robo369">cl_is_list_inited</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="#robo383">cl_list_init</a>, <a href="#robo378">cl_list_destroy</a> and <a href="#robo373">cl_is_list_inited</a>.\r
\r
Calling <strong>cl_list_construct</strong> is a prerequisite to calling any other\r
- list function except <a href="#robo379">cl_list_init</a>.\r
+ list function except <a href="#robo383">cl_list_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo379">cl_list_init</a>, <a href="#robo374">cl_list_destroy</a>, <a href="#robo369">cl_is_list_inited</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo383">cl_list_init</a>, <a href="#robo378">cl_list_destroy</a>, <a href="#robo373">cl_is_list_inited</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
3">[Functions]<a name="Component20Library3a20List2fcl5flist5fcount">
\r+<h2><a name="robo37
7">[Functions]<a name="Component20Library3a20List2fcl5flist5fcount">
\r Component Library: List/cl_list_count</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE size_t CL_API\r
<strong>cl_list_count</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
- return( <a href="./cl_qlist_h.html#robo564">cl_qlist_count</a>( &p_list->list ) );\r
+ return( <a href="./cl_qlist_h.html#robo568">cl_qlist_count</a>( &p_list->list ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure whose object to count.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure whose object to count.\r
\r
RETURN VALUES\r
Number of objects stored in the specified list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
4">[Functions]<a name="Component20Library3a20List2fcl5flist5fdestroy">
\r+<h2><a name="robo37
8">[Functions]<a name="Component20Library3a20List2fcl5flist5fdestroy">
\r Component Library: List/cl_list_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_list_destroy</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list );\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to <a href="#robo395">cl_list_t</a> structure to destroy.\r
+ [in] Pointer to <a href="#robo399">cl_list_t</a> structure to destroy.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
but does release all memory allocated internally. Further operations\r
should not be attempted on the list after <strong>cl_list_destroy</strong> is invoked.\r
\r
- This function should only be called after a call to <a href="#robo372">cl_list_construct</a>\r
- or <a href="#robo379">cl_list_init</a>.\r
+ This function should only be called after a call to <a href="#robo376">cl_list_construct</a>\r
+ or <a href="#robo383">cl_list_init</a>.\r
\r
In debug builds, <strong>cl_list_destroy</strong> asserts if the list is not empty.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo372">cl_list_construct</a>, <a href="#robo379">cl_list_init</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo376">cl_list_construct</a>, <a href="#robo383">cl_list_init</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo37
5">[Functions]<a name="Component20Library3a20List2fcl5flist5fend">
\r+<h2><a name="robo37
9">[Functions]<a name="Component20Library3a20List2fcl5flist5fend">
\r Component Library: List/cl_list_end</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the end of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_end</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
- return( <a href="./cl_qlist_h.html#robo565">cl_qlist_end</a>( &p_list->list ) );\r
+ return( <a href="./cl_qlist_h.html#robo569">cl_qlist_end</a>( &p_list->list ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure for which the iterator for the\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure for which the iterator for the\r
object at the head is to be returned.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
-<span class="RETURN_VALUE"><pre> <a href="#robo386">cl_list_iterator_t</a> for the end of the list.\r
+<span class="RETURN_VALUE"><pre> <a href="#robo390">cl_list_iterator_t</a> for the end of the list.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Use <a href="#robo388">cl_list_obj</a> to retrieve the object associated with the\r
- returned <a href="#robo386">cl_list_iterator_t</a>.\r
+<span class="NOTES"><pre> Use <a href="#robo392">cl_list_obj</a> to retrieve the object associated with the\r
+ returned <a href="#robo390">cl_list_iterator_t</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
76">[Functions]<a name="Component20Library3a20List2fcl5flist5ffind5ffrom5fhead">
\r+<h2><a name="robo3
80">[Functions]<a name="Component20Library3a20List2fcl5flist5ffind5ffrom5fhead">
\r Component Library: List/cl_list_find_from_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
to search for an object starting from the head of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_find_from_head</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN <a href="#robo398">cl_pfn_list_find_t</a> pfn_func,\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo402">cl_pfn_list_find_t</a> pfn_func,\r
IN const void* const context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure to search.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure to search.\r
\r
pfn_func\r
[in] Function invoked to determine if a match was found.\r
- See the <a href="#robo398">cl_pfn_list_find_t</a> function type declaration for details\r
+ See the <a href="#robo402">cl_pfn_list_find_t</a> function type declaration for details\r
about the callback function.\r
\r
context\r
operations as these would corrupt the list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo377">cl_list_find_from_tail</a>, <a href="#robo371">cl_list_apply_func</a>,\r
- <a href="#robo398">cl_pfn_list_find_t</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo381">cl_list_find_from_tail</a>, <a href="#robo375">cl_list_apply_func</a>,\r
+ <a href="#robo402">cl_pfn_list_find_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
77">[Functions]<a name="Component20Library3a20List2fcl5flist5ffind5ffrom5ftail">
\r+<h2><a name="robo3
81">[Functions]<a name="Component20Library3a20List2fcl5flist5ffind5ffrom5ftail">
\r Component Library: List/cl_list_find_from_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
to search for an object starting from the tail of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_find_from_tail</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN <a href="#robo398">cl_pfn_list_find_t</a> pfn_func,\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo402">cl_pfn_list_find_t</a> pfn_func,\r
IN const void* const context );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure to search.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure to search.\r
\r
pfn_func\r
[in] Function invoked to determine if a match was found.\r
- See the <a href="#robo398">cl_pfn_list_find_t</a> function type declaration for details\r
+ See the <a href="#robo402">cl_pfn_list_find_t</a> function type declaration for details\r
about the callback function.\r
\r
context\r
operations as these would corrupt the list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo376">cl_list_find_from_head</a>, <a href="#robo371">cl_list_apply_func</a>,\r
- <a href="#robo398">cl_pfn_list_find_t</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo380">cl_list_find_from_head</a>, <a href="#robo375">cl_list_apply_func</a>,\r
+ <a href="#robo402">cl_pfn_list_find_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
78">[Functions]<a name="Component20Library3a20List2fcl5flist5fhead">
\r+<h2><a name="robo3
82">[Functions]<a name="Component20Library3a20List2fcl5flist5fhead">
\r Component Library: List/cl_list_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the head of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_head</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
- return( <a href="./cl_qlist_h.html#robo570">cl_qlist_head</a>( &p_list->list ) );\r
+ return( <a href="./cl_qlist_h.html#robo574">cl_qlist_head</a>( &p_list->list ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure for which the iterator for the\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure for which the iterator for the\r
object at the head is to be returned.\r
\r
RETURN VALUES\r
- <a href="#robo386">cl_list_iterator_t</a> for the head of the list.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the head of the list.\r
\r
- <a href="#robo386">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Use <a href="#robo388">cl_list_obj</a> to retrieve the object associated with the\r
- returned <a href="#robo386">cl_list_iterator_t</a>.\r
+<span class="NOTES"><pre> Use <a href="#robo392">cl_list_obj</a> to retrieve the object associated with the\r
+ returned <a href="#robo390">cl_list_iterator_t</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>, <a href="#robo375">cl_list_end</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>, <a href="#robo379">cl_list_end</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
79">[Functions]<a name="Component20Library3a20List2fcl5flist5finit">
\r+<h2><a name="robo3
83">[Functions]<a name="Component20Library3a20List2fcl5flist5finit">
\r Component Library: List/cl_list_init</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_list_init</strong> function initializes a list for use.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_init</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const size_t min_items );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to <a href="#robo395">cl_list_t</a> structure to initialize.\r
+ [in] Pointer to <a href="#robo399">cl_list_t</a> structure to initialize.\r
\r
min_items\r
[in] Minimum number of items that can be stored. All necessary\r
by the min_items parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo372">cl_list_construct</a>, <a href="#robo374">cl_list_destroy</a>, <a href="#robo382">cl_list_insert_head</a>,\r
- <a href="#robo385">cl_list_insert_tail</a>, <a href="#robo391">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_tail</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo376">cl_list_construct</a>, <a href="#robo378">cl_list_destroy</a>, <a href="#robo386">cl_list_insert_head</a>,\r
+ <a href="#robo389">cl_list_insert_tail</a>, <a href="#robo395">cl_list_remove_head</a>, <a href="#robo398">cl_list_remove_tail</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
0">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5farray5fhead">
\r+<h2><a name="robo38
4">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5farray5fhead">
\r Component Library: List/cl_list_insert_array_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
at the head of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_array_head</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_array,\r
IN uint32_t item_count,\r
IN const uint32_t item_size );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the objects.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the objects.\r
\r
p_array\r
[in] Pointer to the first object in an array.\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> Inserts all objects in the array to the head of the list, preserving the\r
ordering of the objects. If not successful, no items are added.\r
- <a href="#robo15">List</a> insertion operations are guaranteed to work for the minimum number\r
- of items as specified in <a href="#robo379">cl_list_init</a> by the min_items parameter.\r
+ <a href="#robo16">List</a> insertion operations are guaranteed to work for the minimum number\r
+ of items as specified in <a href="#robo383">cl_list_init</a> by the min_items parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo381">cl_list_insert_array_tail</a>, <a href="#robo382">cl_list_insert_head</a>, <a href="#robo385">cl_list_insert_tail</a>,\r
- <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo383">cl_list_insert_next</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo385">cl_list_insert_array_tail</a>, <a href="#robo386">cl_list_insert_head</a>, <a href="#robo389">cl_list_insert_tail</a>,\r
+ <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo387">cl_list_insert_next</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
1">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5farray5ftail">
\r+<h2><a name="robo38
5">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5farray5ftail">
\r Component Library: List/cl_list_insert_array_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
at the tail of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_array_tail</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_array,\r
IN uint32_t item_count,\r
IN const uint32_t item_size);\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the objects.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the objects.\r
\r
p_array\r
[in] Pointer to the first object in an array.\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> Inserts all objects in the array to the tail of the list, preserving the\r
ordering of the objects. If not successful, no items are added.\r
- <a href="#robo15">List</a> insertion operations are guaranteed to work for the minimum number\r
- of items as specified in <a href="#robo379">cl_list_init</a> by the min_items parameter.\r
+ <a href="#robo16">List</a> insertion operations are guaranteed to work for the minimum number\r
+ of items as specified in <a href="#robo383">cl_list_init</a> by the min_items parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo380">cl_list_insert_array_head</a>, <a href="#robo382">cl_list_insert_head</a>, <a href="#robo385">cl_list_insert_tail</a>,\r
- <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo383">cl_list_insert_next</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo384">cl_list_insert_array_head</a>, <a href="#robo386">cl_list_insert_head</a>, <a href="#robo389">cl_list_insert_tail</a>,\r
+ <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo387">cl_list_insert_next</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
2">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fhead">
\r+<h2><a name="robo38
6">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fhead">
\r Component Library: List/cl_list_insert_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_list_insert_head</strong> function inserts an object at the head of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_head</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_object )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* Get a list item to add to the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo626">cl_qpool_get</a>( &p_list->list_item_pool );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo630">cl_qpool_get</a>( &p_list->list_item_pool );\r
if( !p_pool_obj )\r
return( CL_INSUFFICIENT_MEMORY );\r
\r
p_pool_obj->list_obj.p_object = p_object;\r
- <a href="./cl_qlist_h.html#robo574">cl_qlist_insert_head</a>( &p_list->list, &p_pool_obj->list_obj.list_item );\r
+ <a href="./cl_qlist_h.html#robo578">cl_qlist_insert_head</a>( &p_list->list, &p_pool_obj->list_obj.list_item );\r
return( CL_SUCCESS );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the object.\r
\r
p_object\r
[in] Pointer to an object to insert into the list.\r
CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Inserts the specified object at the head of the list. <a href="#robo15">List</a> insertion\r
+<span class="NOTES"><pre> Inserts the specified object at the head of the list. <a href="#robo16">List</a> insertion\r
operations are guaranteed to work for the minimum number of items as\r
- specified in <a href="#robo379">cl_list_init</a> by the min_items parameter.\r
+ specified in <a href="#robo383">cl_list_init</a> by the min_items parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo385">cl_list_insert_tail</a>, <a href="#robo380">cl_list_insert_array_head</a>,\r
- <a href="#robo381">cl_list_insert_array_tail</a>, <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo383">cl_list_insert_next</a>,\r
- <a href="#robo391">cl_list_remove_head</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo389">cl_list_insert_tail</a>, <a href="#robo384">cl_list_insert_array_head</a>,\r
+ <a href="#robo385">cl_list_insert_array_tail</a>, <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo387">cl_list_insert_next</a>,\r
+ <a href="#robo395">cl_list_remove_head</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
3">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fnext">
\r+<h2><a name="robo38
7">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fnext">
\r Component Library: List/cl_list_insert_next</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the object associated with a given iterator.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_next</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator,\r
IN const void* const p_object )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* Get a list item to add to the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo626">cl_qpool_get</a>( &p_list->list_item_pool );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo630">cl_qpool_get</a>( &p_list->list_item_pool );\r
if( !p_pool_obj )\r
return( CL_INSUFFICIENT_MEMORY );\r
\r
p_pool_obj->list_obj.p_object = p_object;\r
- <a href="./cl_qlist_h.html#robo577">cl_qlist_insert_next</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo559">cl_list_item_t</a>*)iterator,\r
+ <a href="./cl_qlist_h.html#robo581">cl_qlist_insert_next</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo563">cl_list_item_t</a>*)iterator,\r
&p_pool_obj->list_obj.list_item );\r
return( CL_SUCCESS );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the object.\r
\r
iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, or <a href="#robo389">cl_list_prev</a>.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, or <a href="#robo393">cl_list_prev</a>.\r
\r
p_object\r
[in] Pointer to an object to insert into the list.\r
CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo382">cl_list_insert_head</a>, <a href="#robo385">cl_list_insert_tail</a>,\r
- <a href="#robo380">cl_list_insert_array_head</a>, <a href="#robo381">cl_list_insert_array_tail</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo386">cl_list_insert_head</a>, <a href="#robo389">cl_list_insert_tail</a>,\r
+ <a href="#robo384">cl_list_insert_array_head</a>, <a href="#robo385">cl_list_insert_array_tail</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
4">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fprev">
\r+<h2><a name="robo38
8">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5fprev">
\r Component Library: List/cl_list_insert_prev</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the object associated with a given iterator.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_prev</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator,\r
IN const void* const p_object )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* Get a list item to add to the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo626">cl_qpool_get</a>( &p_list->list_item_pool );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo630">cl_qpool_get</a>( &p_list->list_item_pool );\r
if( !p_pool_obj )\r
return( CL_INSUFFICIENT_MEMORY );\r
\r
p_pool_obj->list_obj.p_object = p_object;\r
- <a href="./cl_qlist_h.html#robo578">cl_qlist_insert_prev</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo559">cl_list_item_t</a>*)iterator,\r
+ <a href="./cl_qlist_h.html#robo582">cl_qlist_insert_prev</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo563">cl_list_item_t</a>*)iterator,\r
&p_pool_obj->list_obj.list_item );\r
return( CL_SUCCESS );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the object.\r
\r
iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, or <a href="#robo389">cl_list_prev</a>.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, or <a href="#robo393">cl_list_prev</a>.\r
\r
p_object\r
[in] Pointer to an object to insert into the list.\r
CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo383">cl_list_insert_next</a>, <a href="#robo382">cl_list_insert_head</a>, <a href="#robo385">cl_list_insert_tail</a>,\r
- <a href="#robo380">cl_list_insert_array_head</a>, <a href="#robo381">cl_list_insert_array_tail</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo387">cl_list_insert_next</a>, <a href="#robo386">cl_list_insert_head</a>, <a href="#robo389">cl_list_insert_tail</a>,\r
+ <a href="#robo384">cl_list_insert_array_head</a>, <a href="#robo385">cl_list_insert_array_tail</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo38
5">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5ftail">
\r+<h2><a name="robo38
9">[Functions]<a name="Component20Library3a20List2fcl5flist5finsert5ftail">
\r Component Library: List/cl_list_insert_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_list_insert_tail</strong> function inserts an object at the head of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_insert_tail</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_object )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* Get a list item to add to the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo626">cl_qpool_get</a>( &p_list->list_item_pool );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qpool_h.html#robo630">cl_qpool_get</a>( &p_list->list_item_pool );\r
if( !p_pool_obj )\r
return( CL_INSUFFICIENT_MEMORY );\r
\r
p_pool_obj->list_obj.p_object = p_object;\r
- <a href="./cl_qlist_h.html#robo579">cl_qlist_insert_tail</a>( &p_list->list, &p_pool_obj->list_obj.list_item );\r
+ <a href="./cl_qlist_h.html#robo583">cl_qlist_insert_tail</a>( &p_list->list, &p_pool_obj->list_obj.list_item );\r
return( CL_SUCCESS );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure into which to insert the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure into which to insert the object.\r
\r
p_object\r
[in] Pointer to an object to insert into the list.\r
CL_INSUFFICIENT_MEMORY if there was not enough memory for the insertion.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Inserts the specified object at the tail of the list. <a href="#robo15">List</a> insertion\r
+<span class="NOTES"><pre> Inserts the specified object at the tail of the list. <a href="#robo16">List</a> insertion\r
operations are guaranteed to work for the minimum number of items as\r
- specified in <a href="#robo379">cl_list_init</a> by the min_items parameter.\r
+ specified in <a href="#robo383">cl_list_init</a> by the min_items parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo382">cl_list_insert_head</a>, <a href="#robo380">cl_list_insert_array_head</a>,\r
- <a href="#robo381">cl_list_insert_array_tail</a>, <a href="#robo384">cl_list_insert_prev</a>, <a href="#robo383">cl_list_insert_next</a>,\r
- <a href="#robo394">cl_list_remove_tail</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo386">cl_list_insert_head</a>, <a href="#robo384">cl_list_insert_array_head</a>,\r
+ <a href="#robo385">cl_list_insert_array_tail</a>, <a href="#robo388">cl_list_insert_prev</a>, <a href="#robo387">cl_list_insert_next</a>,\r
+ <a href="#robo398">cl_list_remove_tail</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
86">[Definitions]<a name="Component20Library3a20List2fcl5flist5fiterator5ft">
\r+<h2><a name="robo3
90">[Definitions]<a name="Component20Library3a20List2fcl5flist5fiterator5ft">
\r Component Library: List/cl_list_iterator_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> Iterator type used to walk a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>typedef const <a href="./cl_qlist_h.html#robo559">cl_list_item_t</a> *<strong>cl_list_iterator_t</strong>;\r
+<span class="SYNOPSIS"><pre>typedef const <a href="./cl_qlist_h.html#robo563">cl_list_item_t</a> *<strong>cl_list_iterator_t</strong>;\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> The iterator should be treated as opaque to prevent corrupting the list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
87">[Functions]<a name="Component20Library3a20List2fcl5flist5fnext">
\r+<h2><a name="robo3
91">[Functions]<a name="Component20Library3a20List2fcl5flist5fnext">
\r Component Library: List/cl_list_next</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
in a list after the object associated with a given list iterator.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_next</strong>(\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator )\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator )\r
{\r
CL_ASSERT( iterator );\r
\r
- return( <a href="./cl_qlist_h.html#robo581">cl_qlist_next</a>( iterator ) );\r
+ return( <a href="./cl_qlist_h.html#robo585">cl_qlist_next</a>( iterator ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure for which the iterator for the\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure for which the iterator for the\r
next object is to be returned.\r
\r
iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <strong>cl_list_next</strong>, or <a href="#robo389">cl_list_prev</a>.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <strong>cl_list_next</strong>, or <a href="#robo393">cl_list_prev</a>.\r
\r
RETURN VALUES\r
- <a href="#robo386">cl_list_iterator_t</a> for the object following the object associated with\r
+ <a href="#robo390">cl_list_iterator_t</a> for the object following the object associated with\r
the list iterator specified by the iterator parameter.\r
\r
- <a href="#robo386">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Use <a href="#robo388">cl_list_obj</a> to retrieve the object associated with the\r
- returned <a href="#robo386">cl_list_iterator_t</a>.\r
+<span class="NOTES"><pre> Use <a href="#robo392">cl_list_obj</a> to retrieve the object associated with the\r
+ returned <a href="#robo390">cl_list_iterator_t</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo389">cl_list_prev</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo375">cl_list_end</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo393">cl_list_prev</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo379">cl_list_end</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
88">[Functions]<a name="Component20Library3a20List2fcl5flist5fobj">
\r+<h2><a name="robo3
92">[Functions]<a name="Component20Library3a20List2fcl5flist5fobj">
\r Component Library: List/cl_list_obj</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void* CL_API\r
<strong>cl_list_obj</strong>(\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator )\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator )\r
{\r
CL_ASSERT( iterator );\r
\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, or <a href="#robo389">cl_list_prev</a> whose object is requested.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, or <a href="#robo393">cl_list_prev</a> whose object is requested.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> Pointer to the object associated with the list iterator specified\r
by the iterator parameter.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
89">[Functions]<a name="Component20Library3a20List2fcl5flist5fprev">
\r+<h2><a name="robo3
93">[Functions]<a name="Component20Library3a20List2fcl5flist5fprev">
\r Component Library: List/cl_list_prev</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
in a list before the object associated with a given list iterator.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_prev</strong>(\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator )\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator )\r
{\r
CL_ASSERT( iterator );\r
\r
- return( <a href="./cl_qlist_h.html#robo583">cl_qlist_prev</a>( iterator ) );\r
+ return( <a href="./cl_qlist_h.html#robo587">cl_qlist_prev</a>( iterator ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure for which the iterator for the\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure for which the iterator for the\r
next object is to be returned.\r
\r
iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, or <strong>cl_list_prev</strong>.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, or <strong>cl_list_prev</strong>.\r
\r
RETURN VALUES\r
- <a href="#robo386">cl_list_iterator_t</a> for the object preceding the object associated with\r
+ <a href="#robo390">cl_list_iterator_t</a> for the object preceding the object associated with\r
the list iterator specified by the iterator parameter.\r
\r
- <a href="#robo386">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Use <a href="#robo388">cl_list_obj</a> to retrieve the object associated with the\r
- returned <a href="#robo386">cl_list_iterator_t</a>.\r
+<span class="NOTES"><pre> Use <a href="#robo392">cl_list_obj</a> to retrieve the object associated with the\r
+ returned <a href="#robo390">cl_list_iterator_t</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo396">cl_list_tail</a>, <a href="#robo375">cl_list_end</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo400">cl_list_tail</a>, <a href="#robo379">cl_list_end</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
0">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fall">
\r+<h2><a name="robo39
4">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fall">
\r Component Library: List/cl_list_remove_all</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void CL_API\r
<strong>cl_list_remove_all</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* Return all the list items to the pool. */\r
- <a href="./cl_qpool_h.html#robo630">cl_qpool_put_list</a>( &p_list->list_item_pool, &p_list->list );\r
+ <a href="./cl_qpool_h.html#robo634">cl_qpool_put_list</a>( &p_list->list_item_pool, &p_list->list );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure from which to remove all objects.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure from which to remove all objects.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo391">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_tail</a>, <a href="#robo393">cl_list_remove_object</a>,\r
- <a href="#robo392">cl_list_remove_item</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo395">cl_list_remove_head</a>, <a href="#robo398">cl_list_remove_tail</a>, <a href="#robo397">cl_list_remove_object</a>,\r
+ <a href="#robo396">cl_list_remove_item</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
1">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fhead">
\r+<h2><a name="robo39
5">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fhead">
\r Component Library: List/cl_list_remove_head</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void* CL_API\r
<strong>cl_list_remove_head</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* See if the list is empty. */\r
- if( <a href="./cl_qlist_h.html#robo558">cl_is_qlist_empty</a>( &p_list->list ) )\r
+ if( <a href="./cl_qlist_h.html#robo562">cl_is_qlist_empty</a>( &p_list->list ) )\r
return( NULL );\r
\r
/* Get the item at the head of the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qlist_h.html#robo585">cl_qlist_remove_head</a>( &p_list->list );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qlist_h.html#robo589">cl_qlist_remove_head</a>( &p_list->list );\r
\r
/* Place the pool item back into the pool. */\r
- <a href="./cl_qpool_h.html#robo629">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a>*)p_pool_obj );\r
+ <a href="./cl_qpool_h.html#robo633">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a>*)p_pool_obj );\r
\r
return( (void*)p_pool_obj->list_obj.p_object );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure from which to remove an object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure from which to remove an object.\r
\r
RETURN VALUES\r
Returns the pointer to the object formerly at the head of the list.\r
NULL if the list was empty.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo394">cl_list_remove_tail</a>, <a href="#robo390">cl_list_remove_all</a>, <a href="#robo393">cl_list_remove_object</a>,\r
- <a href="#robo392">cl_list_remove_item</a>, <a href="#robo382">cl_list_insert_head</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo398">cl_list_remove_tail</a>, <a href="#robo394">cl_list_remove_all</a>, <a href="#robo397">cl_list_remove_object</a>,\r
+ <a href="#robo396">cl_list_remove_item</a>, <a href="#robo386">cl_list_insert_head</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
2">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fitem">
\r+<h2><a name="robo39
6">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fitem">
\r Component Library: List/cl_list_remove_item</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void CL_API\r
<strong>cl_list_remove_item</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
- IN const <a href="#robo386">cl_list_iterator_t</a> iterator )\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
+ IN const <a href="#robo390">cl_list_iterator_t</a> iterator )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
- <a href="./cl_qlist_h.html#robo586">cl_qlist_remove_item</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo559">cl_list_item_t</a>*)iterator );\r
+ <a href="./cl_qlist_h.html#robo590">cl_qlist_remove_item</a>( &p_list->list, (<a href="./cl_qlist_h.html#robo563">cl_list_item_t</a>*)iterator );\r
\r
/* Place the list item back into the pool. */\r
- <a href="./cl_qpool_h.html#robo629">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a>*)iterator );\r
+ <a href="./cl_qpool_h.html#robo633">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a>*)iterator );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure from which to remove the item.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure from which to remove the item.\r
\r
iterator\r
- [in] <a href="#robo386">cl_list_iterator_t</a> returned by a previous call to <a href="#robo378">cl_list_head</a>,\r
- <a href="#robo396">cl_list_tail</a>, <a href="#robo387">cl_list_next</a>, or <a href="#robo389">cl_list_prev</a>.\r
+ [in] <a href="#robo390">cl_list_iterator_t</a> returned by a previous call to <a href="#robo382">cl_list_head</a>,\r
+ <a href="#robo400">cl_list_tail</a>, <a href="#robo391">cl_list_next</a>, or <a href="#robo393">cl_list_prev</a>.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo393">cl_list_remove_object</a>, <a href="#robo391">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_tail</a>,\r
- <a href="#robo390">cl_list_remove_all</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo397">cl_list_remove_object</a>, <a href="#robo395">cl_list_remove_head</a>, <a href="#robo398">cl_list_remove_tail</a>,\r
+ <a href="#robo394">cl_list_remove_all</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
3">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fobject">
\r+<h2><a name="robo39
7">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5fobject">
\r Component Library: List/cl_list_remove_object</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_list_remove_object</strong> function removes a specific object from a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_list_remove_object</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list,\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list,\r
IN const void* const p_object );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure from which to remove the object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure from which to remove the object.\r
\r
p_object\r
[in] Pointer to an object to remove from the list.\r
<span class="NOTES"><pre> Removes the first occurrence of an object from a list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo392">cl_list_remove_item</a>, <a href="#robo391">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_tail</a>,\r
- <a href="#robo390">cl_list_remove_all</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo396">cl_list_remove_item</a>, <a href="#robo395">cl_list_remove_head</a>, <a href="#robo398">cl_list_remove_tail</a>,\r
+ <a href="#robo394">cl_list_remove_all</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
4">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5ftail">
\r+<h2><a name="robo39
8">[Functions]<a name="Component20Library3a20List2fcl5flist5fremove5ftail">
\r Component Library: List/cl_list_remove_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE void* CL_API\r
<strong>cl_list_remove_tail</strong>(\r
- IN <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
cl_pool_obj_t *p_pool_obj;\r
\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
/* See if the list is empty. */\r
- if( <a href="./cl_qlist_h.html#robo558">cl_is_qlist_empty</a>( &p_list->list ) )\r
+ if( <a href="./cl_qlist_h.html#robo562">cl_is_qlist_empty</a>( &p_list->list ) )\r
return( NULL );\r
\r
/* Get the item at the head of the list. */\r
- p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qlist_h.html#robo587">cl_qlist_remove_tail</a>( &p_list->list );\r
+ p_pool_obj = (cl_pool_obj_t*)<a href="./cl_qlist_h.html#robo591">cl_qlist_remove_tail</a>( &p_list->list );\r
\r
/* Place the list item back into the pool. */\r
- <a href="./cl_qpool_h.html#robo629">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo547">cl_pool_item_t</a>*)p_pool_obj );\r
+ <a href="./cl_qpool_h.html#robo633">cl_qpool_put</a>( &p_list->list_item_pool, (<a href="./cl_qcomppool_h.html#robo551">cl_pool_item_t</a>*)p_pool_obj );\r
\r
return( (void*)p_pool_obj->list_obj.p_object );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure from which to remove an object.\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure from which to remove an object.\r
\r
RETURN VALUES\r
Returns the pointer to the object formerly at the tail of the list.\r
NULL if the list was empty.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo391">cl_list_remove_head</a>, <a href="#robo390">cl_list_remove_all</a>, <a href="#robo393">cl_list_remove_object</a>,\r
- <a href="#robo392">cl_list_remove_item</a>, <a href="#robo382">cl_list_insert_head</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo395">cl_list_remove_head</a>, <a href="#robo394">cl_list_remove_all</a>, <a href="#robo397">cl_list_remove_object</a>,\r
+ <a href="#robo396">cl_list_remove_item</a>, <a href="#robo386">cl_list_insert_head</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo39
5">[Structures]<a name="Component20Library3a20List2fcl5flist5ft">
\r+<h2><a name="robo39
9">[Structures]<a name="Component20Library3a20List2fcl5flist5ft">
\r Component Library: List/cl_list_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_strutures.html#top">index</a>]</p>\r
<span class="NAME"><pre> <strong>cl_list_t</strong>\r
</pre>\r
</span><p><strong>DESCRIPTION</strong></p>\r
-<span class="DESCRIPTION"><pre> <a href="#robo15">List</a> structure.\r
+<span class="DESCRIPTION"><pre> <a href="#robo16">List</a> structure.\r
\r
The <strong>cl_list_t</strong> structure should be treated as opaque and should be\r
manipulated only through the provided functions.\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>typedef struct _cl_list\r
{\r
- <a href="./cl_qlist_h.html#robo589">cl_qlist_t</a> list;\r
- <a href="./cl_qpool_h.html#robo631">cl_qpool_t</a> list_item_pool;\r
+ <a href="./cl_qlist_h.html#robo593">cl_qlist_t</a> list;\r
+ <a href="./cl_qpool_h.html#robo635">cl_qpool_t</a> list_item_pool;\r
\r
} <strong>cl_list_t</strong>;\r
</pre>\r
Quick pool of list objects for storing objects in the quick list.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
396">[Functions]<a name="Component20Library3a20List2fcl5flist5ftail">
\r+<h2><a name="robo
400">[Functions]<a name="Component20Library3a20List2fcl5flist5ftail">
\r Component Library: List/cl_list_tail</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
the tail of a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo386">cl_list_iterator_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_INLINE const <a href="#robo390">cl_list_iterator_t</a> CL_API\r
<strong>cl_list_tail</strong>(\r
- IN const <a href="#robo395">cl_list_t</a>* const p_list )\r
+ IN const <a href="#robo399">cl_list_t</a>* const p_list )\r
{\r
CL_ASSERT( p_list );\r
- CL_ASSERT( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
+ CL_ASSERT( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_list->list_item_pool ) );\r
\r
- return( <a href="./cl_qlist_h.html#robo590">cl_qlist_tail</a>( &p_list->list ) );\r
+ return( <a href="./cl_qlist_h.html#robo594">cl_qlist_tail</a>( &p_list->list ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_list\r
- [in] Pointer to a <a href="#robo395">cl_list_t</a> structure for which the iterator for the\r
+ [in] Pointer to a <a href="#robo399">cl_list_t</a> structure for which the iterator for the\r
object at the tail is to be returned.\r
\r
RETURN VALUES\r
- <a href="#robo386">cl_list_iterator_t</a> for the tail of the list.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the tail of the list.\r
\r
- <a href="#robo386">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
+ <a href="#robo390">cl_list_iterator_t</a> for the end of the list if the list is empty.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Use <a href="#robo388">cl_list_obj</a> to retrieve the object associated with the\r
+<span class="NOTES"><pre> Use <a href="#robo392">cl_list_obj</a> to retrieve the object associated with the\r
\r
- returned <a href="#robo386">cl_list_iterator_t</a>.\r
+ returned <a href="#robo390">cl_list_iterator_t</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo378">cl_list_head</a>, <a href="#robo387">cl_list_next</a>, <a href="#robo389">cl_list_prev</a>, <a href="#robo375">cl_list_end</a>,\r
- <a href="#robo388">cl_list_obj</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo382">cl_list_head</a>, <a href="#robo391">cl_list_next</a>, <a href="#robo393">cl_list_prev</a>, <a href="#robo379">cl_list_end</a>,\r
+ <a href="#robo392">cl_list_obj</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
397">[Definitions]<a name="Component20Library3a20List2fcl5fpfn5flist5fapply5ft">
\r+<h2><a name="robo
401">[Definitions]<a name="Component20Library3a20List2fcl5fpfn5flist5fapply5ft">
\r Component Library: List/cl_pfn_list_apply_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
[in] Pointer to an object stored in a list.\r
\r
context\r
- [in] Context provided in a call to <a href="#robo371">cl_list_apply_func</a>.\r
+ [in] Context provided in a call to <a href="#robo375">cl_list_apply_func</a>.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for the\r
- function provided by users as a parameter to the <a href="#robo371">cl_list_apply_func</a>\r
+ function provided by users as a parameter to the <a href="#robo375">cl_list_apply_func</a>\r
function.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo371">cl_list_apply_func</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo375">cl_list_apply_func</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
398">[Definitions]<a name="Component20Library3a20List2fcl5fpfn5flist5ffind5ft">
\r+<h2><a name="robo
402">[Definitions]<a name="Component20Library3a20List2fcl5fpfn5flist5ffind5ft">
\r Component Library: List/cl_pfn_list_find_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
used to find objects in a list.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo309">cl_status_t</a>\r
+<span class="SYNOPSIS"><pre>typedef <a href="./cl_types_h.html#robo313">cl_status_t</a>\r
(CL_API *<strong>cl_pfn_list_find_t</strong>)(\r
IN const void* const p_object,\r
IN void* context );\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
<span class="NOTES"><pre> This function type is provided as function prototype reference for the\r
- function provided by users as a parameter to the <a href="#robo376">cl_list_find_from_head</a>\r
- and <a href="#robo377">cl_list_find_from_tail</a> functions.\r
+ function provided by users as a parameter to the <a href="#robo380">cl_list_find_from_head</a>\r
+ and <a href="#robo381">cl_list_find_from_tail</a> functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo15">List</a>, <a href="#robo376">cl_list_find_from_head</a>, <a href="#robo377">cl_list_find_from_tail</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo16">List</a>, <a href="#robo380">cl_list_find_from_head</a>, <a href="#robo381">cl_list_find_from_tail</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_log_h.html</title>\r
+<title>./inc_docs/complib/cl_log_h.html</title>\r
<!-- Source: ./inc/complib/cl_log.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_log.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_log.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:38\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
6">[Modules]<a name="Component20Library2fLog20Provider">
\r+<h2><a name="robo1
7">[Modules]<a name="Component20Library2fLog20Provider">
\r Component Library/Log Provider</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> Log Provider\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo
399">[Functions]<a name="Component20Library3a20Log20Provider2fcl5flog5fevent">
\r+<h2><a name="robo
403">[Functions]<a name="Component20Library3a20Log20Provider2fcl5flog5fevent">
\r Component Library: Log Provider/cl_log_event</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_log_event</strong>(\r
IN const char* const name,\r
- IN const <a href="#robo400">cl_log_type_t</a> type,\r
+ IN const <a href="#robo404">cl_log_type_t</a> type,\r
IN const char* const message,\r
IN const void* const p_data OPTIONAL,\r
IN const uint32_t data_len );\r
\r
type\r
[in] Defines the type of log entry to add to the system log.\r
- See the definition of <a href="#robo400">cl_log_type_t</a> for acceptable values.\r
+ See the definition of <a href="#robo404">cl_log_type_t</a> for acceptable values.\r
\r
message\r
[in] Pointer to an ANSI string containing the text for the log entry.\r
without its accompanying data.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Log Provider, <a href="#robo400">cl_log_type_t</a>\r
+<span class="SEE_ALSO"><pre> Log Provider, <a href="#robo404">cl_log_type_t</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
0">[Definitions]<a name="Component20Library3a20Log20Provider2fcl5flog5ftype5ft">
\r+<h2><a name="robo40
4">[Definitions]<a name="Component20Library3a20Log20Provider2fcl5flog5ftype5ft">
\r Component Library: Log Provider/cl_log_type_t</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_definitions.html#top">index</a>]</p>\r
Indicates a log entry is a fatal error.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> Log Provider, <a href="#robo399">cl_log_event</a>\r
+<span class="SEE_ALSO"><pre> Log Provider, <a href="#robo403">cl_log_event</a>\r
</pre>\r
</span>\r
</body>\r
<html>\r
<head>\r
<link rel="stylesheet" href="../robodoc.css" type="text/css">\r
-<title>./inc_doc/complib/cl_map_h.html</title>\r
+<title>./inc_docs/complib/cl_map_h.html</title>\r
<!-- Source: ./inc/complib/cl_map.h -->\r
<!-- Generated with ROBODoc Version 4.99.17 (Aug 2 2005) -->\r
</head>\r
<body bgcolor="#FFFFFF">\r
-<a name="robo_top_of_doc">Generated from ./inc/complib/cl_map.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Aug 27 2006 10:20:31\r
+<a name="robo_top_of_doc">Generated from ./inc/complib/cl_map.h</a> with <a href="http://sourceforge.net/projects/robodoc/">ROBODoc</a> v4.99.17 on Sun Nov 12 2006 16:36:38\r
<br />\r
<hr />\r
\r
-<h2><a name="robo1
7">[Modules]<a name="Component20Library2fMap">
\r+<h2><a name="robo1
8">[Modules]<a name="Component20Library2fMap">
\r Component Library/Map</a></h2>\r
\r
-<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
+<p>[<a href="#robo_top_of_doc">top</a>][<a href="./comp_lib_h.html#robo9">parent</a>][<a href="../robo_modules.html#top">index</a>]</p>\r
<p><strong>NAME</strong></p>\r
<span class="NAME"><pre> <strong>Map</strong>\r
</pre>\r
<strong>Map</strong> is not thread safe, and users must provide serialization when adding\r
and removing items from the map.\r
\r
- The map functions operates on a <a href="#robo420">cl_map_t</a> structure which should be treated\r
+ The map functions operates on a <a href="#robo424">cl_map_t</a> structure which should be treated\r
as opaque and should be manipulated only through the provided functions.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
<span class="SEE_ALSO"><pre> Types:\r
- <a href="#robo411">cl_map_iterator_t</a>\r
+ <a href="#robo415">cl_map_iterator_t</a>\r
\r
Structures:\r
- <a href="#robo420">cl_map_t</a>, <a href="./cl_qmap_h.html#robo598">cl_map_item_t</a>, <a href="./cl_qmap_h.html#robo599">cl_map_obj_t</a>\r
+ <a href="#robo424">cl_map_t</a>, <a href="./cl_qmap_h.html#robo602">cl_map_item_t</a>, <a href="./cl_qmap_h.html#robo603">cl_map_obj_t</a>\r
\r
Item Manipulation:\r
- <a href="#robo415">cl_map_obj</a>, <a href="#robo412">cl_map_key</a>\r
+ <a href="#robo419">cl_map_obj</a>, <a href="#robo416">cl_map_key</a>\r
\r
Initialization:\r
- <a href="#robo402">cl_map_construct</a>, <a href="#robo409">cl_map_init</a>, <a href="#robo405">cl_map_destroy</a>\r
+ <a href="#robo406">cl_map_construct</a>, <a href="#robo413">cl_map_init</a>, <a href="#robo409">cl_map_destroy</a>\r
\r
Iteration:\r
- <a href="#robo406">cl_map_end</a>, <a href="#robo408">cl_map_head</a>, <a href="#robo421">cl_map_tail</a>, <a href="#robo414">cl_map_next</a>, <a href="#robo416">cl_map_prev</a>\r
+ <a href="#robo410">cl_map_end</a>, <a href="#robo412">cl_map_head</a>, <a href="#robo425">cl_map_tail</a>, <a href="#robo418">cl_map_next</a>, <a href="#robo420">cl_map_prev</a>\r
\r
Manipulation\r
- <a href="#robo410">cl_map_insert</a>, <a href="#robo407">cl_map_get</a>, <a href="#robo419">cl_map_remove_item</a>, <a href="#robo417">cl_map_remove</a>,\r
- <a href="#robo418">cl_map_remove_all</a>, <a href="#robo413">cl_map_merge</a>, <a href="#robo404">cl_map_delta</a>\r
+ <a href="#robo414">cl_map_insert</a>, <a href="#robo411">cl_map_get</a>, <a href="#robo423">cl_map_remove_item</a>, <a href="#robo421">cl_map_remove</a>,\r
+ <a href="#robo422">cl_map_remove_all</a>, <a href="#robo417">cl_map_merge</a>, <a href="#robo408">cl_map_delta</a>\r
\r
Attributes:\r
- <a href="#robo403">cl_map_count</a>, <a href="#robo401">cl_is_map_empty</a>, <a href="#robo327">cl_is_map_inited</a>\r
+ <a href="#robo407">cl_map_count</a>, <a href="#robo405">cl_is_map_empty</a>, <a href="#robo331">cl_is_map_inited</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo3
27">[Functions]<a name="Component20Library3a20Event2fcl5fis5fmap5finited">
\r+<h2><a name="robo3
31">[Functions]<a name="Component20Library3a20Event2fcl5fis5fmap5finited">
\r Component Library: Event/cl_is_map_inited</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_map_inited</strong>(\r
- IN const <a href="#robo420">cl_map_t</a>* const p_map )\r
+ IN const <a href="#robo424">cl_map_t</a>* const p_map )\r
{\r
/*\r
* The map's pool of map items is the last thing initialized.\r
* We can therefore use it to test for initialization.\r
*/\r
- return( <a href="./cl_qpool_h.html#robo620">cl_is_qpool_inited</a>( &p_map->pool ) );\r
+ return( <a href="./cl_qpool_h.html#robo624">cl_is_qpool_inited</a>( &p_map->pool ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo420">cl_map_t</a> structure whose initialization state\r
+ [in] Pointer to a <a href="#robo424">cl_map_t</a> structure whose initialization state\r
to check.\r
\r
RETURN VALUES\r
member functions is appropriate.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo17">Map</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo18">Map</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
1">[Functions]<a name="Component20Library3a20Map2fcl5fis5fmap5fempty">
\r+<h2><a name="robo40
5">[Functions]<a name="Component20Library3a20Map2fcl5fis5fmap5fempty">
\r Component Library: Map/cl_is_map_empty</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE boolean_t CL_API\r
<strong>cl_is_map_empty</strong>(\r
- IN const <a href="#robo420">cl_map_t</a>* const p_map )\r
+ IN const <a href="#robo424">cl_map_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
- return( <a href="./cl_qmap_h.html#robo597">cl_is_qmap_empty</a>( &p_map->qmap ) );\r
+ return( <a href="./cl_qmap_h.html#robo601">cl_is_qmap_empty</a>( &p_map->qmap ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
FALSE otherwise.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo17">Map</a>, <a href="#robo403">cl_map_count</a>, <a href="#robo418">cl_map_remove_all</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo18">Map</a>, <a href="#robo407">cl_map_count</a>, <a href="#robo422">cl_map_remove_all</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
2">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fconstruct">
\r+<h2><a name="robo40
6">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fconstruct">
\r Component Library: Map/cl_map_construct</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_map_construct</strong>(\r
- IN <a href="#robo420">cl_map_t</a>* const p_map );\r
+ IN <a href="#robo424">cl_map_t</a>* const p_map );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map\r
- [in] Pointer to a <a href="#robo420">cl_map_t</a> structure to construct.\r
+ [in] Pointer to a <a href="#robo424">cl_map_t</a> structure to construct.\r
</pre>\r
</span><p><strong>RETURN VALUE</strong></p>\r
<span class="RETURN_VALUE"><pre> This function does not return a value.\r
</pre>\r
</span><p><strong>NOTES</strong></p>\r
-<span class="NOTES"><pre> Allows calling <a href="#robo409">cl_map_init</a>, <a href="#robo405">cl_map_destroy</a>, and <a href="#robo327">cl_is_map_inited</a>.\r
+<span class="NOTES"><pre> Allows calling <a href="#robo413">cl_map_init</a>, <a href="#robo409">cl_map_destroy</a>, and <a href="#robo331">cl_is_map_inited</a>.\r
\r
Calling <strong>cl_map_construct</strong> is a prerequisite to calling any other\r
- map function except <a href="#robo409">cl_map_init</a>.\r
+ map function except <a href="#robo413">cl_map_init</a>.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo17">Map</a>, <a href="#robo409">cl_map_init</a>, <a href="#robo405">cl_map_destroy</a>, <a href="#robo327">cl_is_map_inited</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo18">Map</a>, <a href="#robo413">cl_map_init</a>, <a href="#robo409">cl_map_destroy</a>, <a href="#robo331">cl_is_map_inited</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
3">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fcount">
\r+<h2><a name="robo40
7">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fcount">
\r Component Library: Map/cl_map_count</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_INLINE size_t CL_API\r
<strong>cl_map_count</strong>(\r
- IN const <a href="#robo420">cl_map_t</a>* const p_map )\r
+ IN const <a href="#robo424">cl_map_t</a>* const p_map )\r
{\r
CL_ASSERT( p_map );\r
- return( <a href="./cl_qmap_h.html#robo602">cl_qmap_count</a>( &p_map->qmap ) );\r
+ return( <a href="./cl_qmap_h.html#robo606">cl_qmap_count</a>( &p_map->qmap ) );\r
}\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="RETURN_VALUE"><pre> Returns the number of items stored in the map.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo17">Map</a>, <a href="#robo401">cl_is_map_empty</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo18">Map</a>, <a href="#robo405">cl_is_map_empty</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
4">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fdelta">
\r+<h2><a name="robo40
8">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fdelta">
\r Component Library: Map/cl_map_delta</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
<span class="DESCRIPTION"><pre> The <strong>cl_map_delta</strong> function computes the differences between two maps.\r
</pre>\r
</span><p><strong>SYNOPSIS</strong></p>\r
-<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo309">cl_status_t</a> CL_API\r
+<span class="SYNOPSIS"><pre>CL_EXPORT <a href="./cl_types_h.html#robo313">cl_status_t</a> CL_API\r
<strong>cl_map_delta</strong>(\r
- IN OUT <a href="#robo420">cl_map_t</a>* const p_map1,\r
- IN OUT <a href="#robo420">cl_map_t</a>* const p_map2,\r
- OUT <a href="#robo420">cl_map_t</a>* const p_new,\r
- OUT <a href="#robo420">cl_map_t</a>* const p_old );\r
+ IN OUT <a href="#robo424">cl_map_t</a>* const p_map1,\r
+ IN OUT <a href="#robo424">cl_map_t</a>* const p_map2,\r
+ OUT <a href="#robo424">cl_map_t</a>* const p_new,\r
+ OUT <a href="#robo424">cl_map_t</a>* const p_old );\r
</pre>\r
</span><p><strong>PARAMETERS</strong></p>\r
<span class="PARAMETERS"><pre> p_map1\r
- [in/out] Pointer to the first of two <a href="#robo420">cl_map_t</a> structures whose\r
+ [in/out] Pointer to the first of two <a href="#robo424">cl_map_t</a> structures whose\r
differences to compute.\r
\r
p_map2\r
- [in/out] Pointer to the second of two <a href="#robo420">cl_map_t</a> structures whose\r
+ [in/out] Pointer to the second of two <a href="#robo424">cl_map_t</a> structures whose\r
differences to compute.\r
\r
p_new\r
- [out] Pointer to an empty <a href="#robo420">cl_map_t</a> structure that contains the items\r
+ [out] Pointer to an empty <a href="#robo424">cl_map_t</a> structure that contains the items\r
unique to p_map2 upon return from the function.\r
\r
p_old\r
- [out] Pointer to an empty <a href="#robo420">cl_map_t</a> structure that contains the items\r
+ [out] Pointer to an empty <a href="#robo424">cl_map_t</a> structure that contains the items\r
unique to p_map1 upon return from the function.\r
\r
RETURN VALUES\r
Upon failure, all input maps are restored to their original state.\r
</pre>\r
</span><p><strong>SEE ALSO</strong></p>\r
-<span class="SEE_ALSO"><pre> <a href="#robo17">Map</a>, <a href="#robo413">cl_map_merge</a>\r
+<span class="SEE_ALSO"><pre> <a href="#robo18">Map</a>, <a href="#robo417">cl_map_merge</a>\r
</pre>\r
</span>\r
<hr />\r
\r
-<h2><a name="robo40
5">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fdestroy">
\r+<h2><a name="robo40
9">[Functions]<a name="Component20Library3a20Map2fcl5fmap5fdestroy">
\r Component Library: Map/cl_map_destroy</a></h2>\r
\r
<p>[<a href="#robo_top_of_doc">top</a>][<a href="../robo_functions.html#top">index</a>]</p>\r
</span><p><strong>SYNOPSIS</strong></p>\r
<span class="SYNOPSIS"><pre>CL_EXPORT void CL_API\r
<strong>cl_map_destroy</strong>(\r
- IN <a href="#robo420">cl_map_t</a>* const p_map );\r
+ IN <a href="#robo424">cl_map_t</a>* const p_map );
http://git.etherboot.org / mirror / winof / .git / commitdiff