docs/html/gumd-Gum-Utils.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gumd API Reference Manual: Gum Utils</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gumd API Reference Manual">
   8 <link rel="up" href="ch02.html" title="Common">
   9 <link rel="prev" href="gumd-Gum-String-Utils.html" title="Gum String Utils">
  10 <link rel="next" href="gumd-User-types.html" title="User types">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#gumd-Gum-Utils.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#gumd-Gum-Utils.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gumd-Gum-String-Utils.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gumd-User-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="gumd-Gum-Utils"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gumd-Gum-Utils.top_of_page"></a>Gum Utils</span></h2>
  31 <p>Gum Utils — Utility functions</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="gumd-Gum-Utils.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="gumd-Gum-Utils.html#gum-utils-generate-nonce" title="gum_utils_generate_nonce ()">gum_utils_generate_nonce</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <span class="returnvalue">void</span>
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="gumd-Gum-Utils.html#gum-utils-drop-privileges" title="gum_utils_drop_privileges ()">gum_utils_drop_privileges</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="gumd-Gum-Utils.html#gum-utils-gain-privileges" title="gum_utils_gain_privileges ()">gum_utils_gain_privileges</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="gumd-Gum-Utils.html#gum-utils-run-user-scripts" title="gum_utils_run_user_scripts ()">gum_utils_run_user_scripts</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="gumd-Gum-Utils.html#gum-utils-run-group-scripts" title="gum_utils_run_group_scripts ()">gum_utils_run_group_scripts</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </div>
  86 <div class="refsect1">
  87 <a name="gumd-Gum-Utils.object-hierarchy"></a><h2>Object Hierarchy</h2>
  88 <pre class="screen">
  89 </pre>
  90 </div>
  91 <div class="refsect1">
  92 <a name="gumd-Gum-Utils.includes"></a><h2>Includes</h2>
  93 <pre class="synopsis">#include &lt;gum/common/gum-utils.h&gt;
  94 </pre>
  95 </div>
  96 <div class="refsect1">
  97 <a name="gumd-Gum-Utils.description"></a><h2>Description</h2>
  98 <p>Utility functions</p>
  99 </div>
 100 <div class="refsect1">
 101 <a name="gumd-Gum-Utils.functions_details"></a><h2>Functions</h2>
 102 <div class="refsect2">
 103 <a name="gum-utils-generate-nonce"></a><h3>gum_utils_generate_nonce ()</h3>
 104 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 105 gum_utils_generate_nonce (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Data-Checksums.html#GChecksumType"><span class="type">GChecksumType</span></a> algorithm</code></em>);</pre>
 106 <p>Generates nonce based on hashing algorithm as specified in <em class="parameter"><code>algorithm</code></em>
 107 </p>
 108 <div class="refsect3">
 109 <a name="id-1.5.11.7.2.5"></a><h4>Parameters</h4>
 110 <div class="informaltable"><table width="100%" border="0">
 111 <colgroup>
 112 <col width="150px" class="parameters_name">
 113 <col class="parameters_description">
 114 <col width="200px" class="parameters_annotations">
 115 </colgroup>
 116 <tbody><tr>
 117 <td class="parameter_name"><p>algorithm</p></td>
 118 <td class="parameter_description"><p>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Data-Checksums.html#GChecksumType"><span class="type">GChecksumType</span></a> algorithm</p></td>
 119 <td class="parameter_annotations"> </td>
 120 </tr></tbody>
 121 </table></div>
 122 </div>
 123 <div class="refsect3">
 124 <a name="id-1.5.11.7.2.6"></a><h4>Returns</h4>
 125 <p> generate nonce if successful, NULL otherwise. </p>
 126 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 127 </div>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="gum-utils-drop-privileges"></a><h3>gum_utils_drop_privileges ()</h3>
 132 <pre class="programlisting"><span class="returnvalue">void</span>
 133 gum_utils_drop_privileges ();</pre>
 134 <p>Drops the privileges for the calling process. Effective uid is to real uid.</p>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="gum-utils-gain-privileges"></a><h3>gum_utils_gain_privileges ()</h3>
 139 <pre class="programlisting"><span class="returnvalue">void</span>
 140 gum_utils_gain_privileges ();</pre>
 141 <p>Gains the privileges for the calling process. Effective uid is to 0.</p>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="gum-utils-run-user-scripts"></a><h3>gum_utils_run_user_scripts ()</h3>
 146 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 147 gum_utils_run_user_scripts (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *script_dir</code></em>,
 148                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
 149                             <em class="parameter"><code><span class="type">uid_t</span> uid</code></em>,
 150                             <em class="parameter"><code><span class="type">gid_t</span> gid</code></em>,
 151                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *homedir</code></em>);</pre>
 152 <p>Runs the user scripts in sorted order.</p>
 153 <div class="refsect3">
 154 <a name="id-1.5.11.7.5.5"></a><h4>Parameters</h4>
 155 <div class="informaltable"><table width="100%" border="0">
 156 <colgroup>
 157 <col width="150px" class="parameters_name">
 158 <col class="parameters_description">
 159 <col width="200px" class="parameters_annotations">
 160 </colgroup>
 161 <tbody>
 162 <tr>
 163 <td class="parameter_name"><p>script_dir</p></td>
 164 <td class="parameter_description"><p>path to the scripts directory</p></td>
 165 <td class="parameter_annotations"> </td>
 166 </tr>
 167 <tr>
 168 <td class="parameter_name"><p>username</p></td>
 169 <td class="parameter_description"><p>name of the user</p></td>
 170 <td class="parameter_annotations"> </td>
 171 </tr>
 172 <tr>
 173 <td class="parameter_name"><p>uid</p></td>
 174 <td class="parameter_description"><p>uid of the user</p></td>
 175 <td class="parameter_annotations"> </td>
 176 </tr>
 177 <tr>
 178 <td class="parameter_name"><p>gid</p></td>
 179 <td class="parameter_description"><p>gid of the user</p></td>
 180 <td class="parameter_annotations"> </td>
 181 </tr>
 182 <tr>
 183 <td class="parameter_name"><p>homedir</p></td>
 184 <td class="parameter_description"><p>home directory of the user</p></td>
 185 <td class="parameter_annotations"> </td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 </div>
 190 <div class="refsect3">
 191 <a name="id-1.5.11.7.5.6"></a><h4>Returns</h4>
 192 <p> TRUE if successful, FALSE otherwise</p>
 193 <p></p>
 194 </div>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="gum-utils-run-group-scripts"></a><h3>gum_utils_run_group_scripts ()</h3>
 199 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 200 gum_utils_run_group_scripts (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *script_dir</code></em>,
 201                              <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *groupname</code></em>,
 202                              <em class="parameter"><code><span class="type">gid_t</span> gid</code></em>);</pre>
 203 <p>Runs the group scripts in sorted order.</p>
 204 <div class="refsect3">
 205 <a name="id-1.5.11.7.6.5"></a><h4>Parameters</h4>
 206 <div class="informaltable"><table width="100%" border="0">
 207 <colgroup>
 208 <col width="150px" class="parameters_name">
 209 <col class="parameters_description">
 210 <col width="200px" class="parameters_annotations">
 211 </colgroup>
 212 <tbody>
 213 <tr>
 214 <td class="parameter_name"><p>script_dir</p></td>
 215 <td class="parameter_description"><p>path to the scripts directory</p></td>
 216 <td class="parameter_annotations"> </td>
 217 </tr>
 218 <tr>
 219 <td class="parameter_name"><p>groupname</p></td>
 220 <td class="parameter_description"><p>name of the group</p></td>
 221 <td class="parameter_annotations"> </td>
 222 </tr>
 223 <tr>
 224 <td class="parameter_name"><p>gid</p></td>
 225 <td class="parameter_description"><p>gid of the group</p></td>
 226 <td class="parameter_annotations"> </td>
 227 </tr>
 228 </tbody>
 229 </table></div>
 230 </div>
 231 <div class="refsect3">
 232 <a name="id-1.5.11.7.6.6"></a><h4>Returns</h4>
 233 <p> TRUE if successful, FALSE otherwise</p>
 234 <p></p>
 235 </div>
 236 </div>
 237 </div>
 238 <div class="refsect1">
 239 <a name="gumd-Gum-Utils.other_details"></a><h2>Types and Values</h2>
 240 </div>
 241 </div>
 242 <div class="footer">
 243 <hr>
 244           Generated by GTK-Doc V1.20</div>
 245 </body>
 246 </html>