<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.6"/> <title>libcomps: COMPS_DocGroup properties getters</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libcomps  <span id="projectnumber">..</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">COMPS_DocGroup properties getters</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga6e1fa48c9d5e21457aea864e9728074f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#ga6e1fa48c9d5e21457aea864e9728074f">comps_docgroup_get_id</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:ga6e1fa48c9d5e21457aea864e9728074f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadded5fa59615cfe5d05abbde35368c17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#gadded5fa59615cfe5d05abbde35368c17">comps_docgroup_get_name</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:gadded5fa59615cfe5d05abbde35368c17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga33b12fa2dc04fa641f5d37c435c3c2c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#ga33b12fa2dc04fa641f5d37c435c3c2c2">comps_docgroup_get_desc</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:ga33b12fa2dc04fa641f5d37c435c3c2c2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga23ff2ca0cd28942869b236a110df14a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#ga23ff2ca0cd28942869b236a110df14a4">comps_docgroup_get_def</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:ga23ff2ca0cd28942869b236a110df14a4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5233b7f13196f71c9924c0c34815b085"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#ga5233b7f13196f71c9924c0c34815b085">comps_docgroup_get_uservisible</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:ga5233b7f13196f71c9924c0c34815b085"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9505f4dbafd9f1fb559a468ee50c6276"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#ga9505f4dbafd9f1fb559a468ee50c6276">comps_docgroup_get_display_order</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:ga9505f4dbafd9f1fb559a468ee50c6276"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaafecb06623a423bb484269b4cfb4c84a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocGroup__prop__getters.html#gaafecb06623a423bb484269b4cfb4c84a">comps_docgroup_get_langonly</a> (<a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> *group)</td></tr> <tr class="separator:gaafecb06623a423bb484269b4cfb4c84a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga23ff2ca0cd28942869b236a110df14a4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_def </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> default getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Num.html">COMPS_Num</a> object representing group default with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="ga33b12fa2dc04fa641f5d37c435c3c2c2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_desc </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> description getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Str.html">COMPS_Str</a> object representing group description with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="ga9505f4dbafd9f1fb559a468ee50c6276"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_display_order </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> display_order getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Num.html">COMPS_Num</a> object representing group display_order with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="ga6e1fa48c9d5e21457aea864e9728074f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_id </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> id getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Str.html">COMPS_Str</a> object representing group id with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="gaafecb06623a423bb484269b4cfb4c84a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_langonly </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> langonly getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Str.html">COMPS_Str</a> object representing group langonly with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="gadded5fa59615cfe5d05abbde35368c17"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_name </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> name getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Str.html">COMPS_Str</a> object representing group name with incremented reference count </dd></dl> </div> </div> <a class="anchor" id="ga5233b7f13196f71c9924c0c34815b085"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a>* comps_docgroup_get_uservisible </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> * </td> <td class="paramname"><em>group</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> uservisible getter </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td><a class="el" href="structCOMPS__DocGroup.html">COMPS_DocGroup</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structCOMPS__Num.html">COMPS_Num</a> object representing group uservisible with incremented reference count </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> </body> </html>