| Current File : //usr/share/doc/dbus/api/dbus-userdb_8h_source.html |
<!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"/>
<title>D-Bus: dbus-userdb.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">D-Bus
 <span id="projectnumber">1.8.20</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">dbus-userdb.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/* dbus-userdb.h User database abstraction</span>
<a name="l00003"></a>00003 <span class="comment"> * </span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2003 Red Hat, Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00011"></a>00011 <span class="comment"> * (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef DBUS_USERDB_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_USERDB_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <dbus/dbus-sysdeps-unix.h></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifdef DBUS_WIN</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#error "Don't include this on Windows"</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <a class="code" href="group__DBusMacros.html#ga875146b01015e9ced22b25d76d549ab2" title="Macro used prior to declaring functions in the D-Bus header files.">DBUS_BEGIN_DECLS</a>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <span class="keyword">struct </span>DBusUserDatabase DBusUserDatabase;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#ifdef DBUS_USERDB_INCLUDES_PRIVATE</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#include <dbus/dbus-hash.h></span>
<a name="l00039"></a>00039
<a name="l00043"></a>00043 <span class="keyword">struct </span>DBusUserDatabase
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keywordtype">int</span> refcount;
<a name="l00047"></a>00047 <a class="code" href="structDBusHashTable.html" title="Internals of DBusHashTable.">DBusHashTable</a> *users;
<a name="l00048"></a>00048 <a class="code" href="structDBusHashTable.html" title="Internals of DBusHashTable.">DBusHashTable</a> *groups;
<a name="l00049"></a>00049 <a class="code" href="structDBusHashTable.html" title="Internals of DBusHashTable.">DBusHashTable</a> *users_by_name;
<a name="l00050"></a>00050 <a class="code" href="structDBusHashTable.html" title="Internals of DBusHashTable.">DBusHashTable</a> *groups_by_name;
<a name="l00052"></a>00052 };
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00055"></a>00055 DBusUserDatabase* <a class="code" href="group__DBusInternalsUtils.html#ga1dbf2c80952d17707c544f5d86dd8545" title="Creates a new user database object used to look up and cache user information.">_dbus_user_database_new</a> (<span class="keywordtype">void</span>);
<a name="l00056"></a>00056 DBusUserDatabase* _dbus_user_database_ref (DBusUserDatabase *db);
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#gab553751e96f8506d10349fb5fb1eaa82" title="Flush all information out of the user database.">_dbus_user_database_flush</a> (DBusUserDatabase *db);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#ga55dbb78c415da040037442eca4c4e80e" title="Decrements refcount of user database.">_dbus_user_database_unref</a> (DBusUserDatabase *db);
<a name="l00059"></a>00059 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga6a7e8b8cf3a6968972e9a49726022638" title="Gets the user information for the given UID, returned user info should not be freed.">_dbus_user_database_get_uid</a> (DBusUserDatabase *db,
<a name="l00060"></a>00060 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid,
<a name="l00061"></a>00061 <span class="keyword">const</span> <a class="code" href="structDBusUserInfo.html" title="Information about a UNIX user.">DBusUserInfo</a> **info,
<a name="l00062"></a>00062 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00063"></a>00063 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga70d3fd2edd61c69edc6f7fe1d5cfa6ea" title="Gets the user information for the given GID, returned group info should not be freed.">_dbus_user_database_get_gid</a> (DBusUserDatabase *db,
<a name="l00064"></a>00064 <a class="code" href="group__DBusSysdeps.html#ga2f5c2e418b81ec2a86594f56ec6d7627" title="A group ID.">dbus_gid_t</a> gid,
<a name="l00065"></a>00065 <span class="keyword">const</span> <a class="code" href="structDBusGroupInfo.html" title="Information about a UNIX group.">DBusGroupInfo</a> **info,
<a name="l00066"></a>00066 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00067"></a>00067 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gaccf1d5b330707a1835dcf4ce49a29c8c" title="Gets the user information for the given username.">_dbus_user_database_get_username</a> (DBusUserDatabase *db,
<a name="l00068"></a>00068 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *username,
<a name="l00069"></a>00069 <span class="keyword">const</span> <a class="code" href="structDBusUserInfo.html" title="Information about a UNIX user.">DBusUserInfo</a> **info,
<a name="l00070"></a>00070 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00071"></a>00071 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gad370299b907799440331c47e8d2357e0" title="Gets the user information for the given group name, returned group info should not be freed...">_dbus_user_database_get_groupname</a> (DBusUserDatabase *db,
<a name="l00072"></a>00072 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *groupname,
<a name="l00073"></a>00073 <span class="keyword">const</span> <a class="code" href="structDBusGroupInfo.html" title="Information about a UNIX group.">DBusGroupInfo</a> **info,
<a name="l00074"></a>00074 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <a class="code" href="structDBusUserInfo.html" title="Information about a UNIX user.">DBusUserInfo</a>* <a class="code" href="group__DBusInternalsUtils.html#ga959372f7d7cdea35ffbac3b78e29a1b0" title="Looks up a uid or username in the user database.">_dbus_user_database_lookup</a> (DBusUserDatabase *db,
<a name="l00077"></a>00077 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid,
<a name="l00078"></a>00078 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *username,
<a name="l00079"></a>00079 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00080"></a>00080 <a class="code" href="structDBusGroupInfo.html" title="Information about a UNIX group.">DBusGroupInfo</a>* <a class="code" href="group__DBusInternalsUtils.html#gaf6b7452691c0c7d11fec4b9214137052" title="Looks up a gid or group name in the user database.">_dbus_user_database_lookup_group</a> (DBusUserDatabase *db,
<a name="l00081"></a>00081 <a class="code" href="group__DBusSysdeps.html#ga2f5c2e418b81ec2a86594f56ec6d7627" title="A group ID.">dbus_gid_t</a> gid,
<a name="l00082"></a>00082 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *groupname,
<a name="l00083"></a>00083 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00084"></a>00084 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#gaf725ba6f380a3b926650626eef714b67" title="Frees the given DBusUserInfo's members with _dbus_user_info_free() and also calls dbus_free() on the ...">_dbus_user_info_free_allocated</a> (<a class="code" href="structDBusUserInfo.html" title="Information about a UNIX user.">DBusUserInfo</a> *info);
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#gab9420d7a4a31329a00fd5709f8cf08ba" title="Frees the given DBusGroupInfo's members with _dbus_group_info_free() and also calls dbus_free() on th...">_dbus_group_info_free_allocated</a> (<a class="code" href="structDBusGroupInfo.html" title="Information about a UNIX group.">DBusGroupInfo</a> *info);
<a name="l00086"></a>00086 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_USERDB_INCLUDES_PRIVATE */</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 DBusUserDatabase* <a class="code" href="group__DBusInternalsUtils.html#ga79b6c3cf0d735622b6af2795840f9d21" title="Gets the system global user database; must be called with lock held (_dbus_user_database_lock_system(...">_dbus_user_database_get_system</a> (<span class="keywordtype">void</span>);
<a name="l00089"></a>00089 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga15df3b3fdaa4946f69ff87f3a9a03fe7" title="Locks global system user database.">_dbus_user_database_lock_system</a> (<span class="keywordtype">void</span>) _DBUS_GNUC_WARN_UNUSED_RESULT;
<a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#ga468e1d62e1df24bb699c4a37fdfa274c" title="Unlocks global system user database.">_dbus_user_database_unlock_system</a> (<span class="keywordtype">void</span>);
<a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="group__DBusInternalsUtils.html#ga788ce7775d7f812d28d931e8b87ddfde" title="Flushes the system global user database;.">_dbus_user_database_flush_system</a> (<span class="keywordtype">void</span>);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gaf07ee24eddcb3b0f85fa54196bc44fe1" title="Gets user ID given username.">_dbus_get_user_id</a> (const <a class="code" href="structDBusString.html">DBusString</a> *username,
<a name="l00094"></a>00094 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> *uid);
<a name="l00095"></a>00095 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga90657adefa9bbac9b35eee63dd46a854" title="Gets group ID given groupname.">_dbus_get_group_id</a> (const <a class="code" href="structDBusString.html">DBusString</a> *group_name,
<a name="l00096"></a>00096 <a class="code" href="group__DBusSysdeps.html#ga2f5c2e418b81ec2a86594f56ec6d7627" title="A group ID.">dbus_gid_t</a> *gid);
<a name="l00097"></a>00097 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gac82f42ff83fabbde717cc08569265e6e" title="Gets user ID and primary group given username.">_dbus_get_user_id_and_primary_group</a> (const <a class="code" href="structDBusString.html">DBusString</a> *username,
<a name="l00098"></a>00098 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> *uid_p,
<a name="l00099"></a>00099 <a class="code" href="group__DBusSysdeps.html#ga2f5c2e418b81ec2a86594f56ec6d7627" title="A group ID.">dbus_gid_t</a> *gid_p);
<a name="l00100"></a>00100 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> _dbus_credentials_from_uid (<a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> user_id,
<a name="l00101"></a>00101 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00102"></a>00102 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gae9408936869314101f8ea13dfa5ba968" title="Gets all groups corresponding to the given UID.">_dbus_groups_from_uid</a> (<a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid,
<a name="l00103"></a>00103 <a class="code" href="group__DBusSysdeps.html#ga2f5c2e418b81ec2a86594f56ec6d7627" title="A group ID.">dbus_gid_t</a> **group_ids,
<a name="l00104"></a>00104 <span class="keywordtype">int</span> *n_group_ids);
<a name="l00105"></a>00105 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gaa504db352a939909051a494d06c5b607" title="Checks to see if the UID sent in is the console user.">_dbus_is_console_user</a> (<a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid,
<a name="l00106"></a>00106 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gad1c3538c544df91f438a13c9fb4d3a1b" title="Checks if a given string is actually a number and converts it if it is.">_dbus_is_a_number</a> (const <a class="code" href="structDBusString.html">DBusString</a> *str,
<a name="l00109"></a>00109 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *num);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga9c4c1850787bfd457107b95fa1878869" title="Gets username of user owning current process.">_dbus_username_from_current_process</a> (const <a class="code" href="structDBusString.html">DBusString</a> **username);
<a name="l00112"></a>00112 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga17ce3ab061a3ae2441cd33ece34f5e7a" title="Gets homedir of user owning current process.">_dbus_homedir_from_current_process</a> (const <a class="code" href="structDBusString.html">DBusString</a> **homedir);
<a name="l00113"></a>00113 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#ga91c63dcb68d38347578edf39eda1712a" title="Gets the home directory for the given user.">_dbus_homedir_from_username</a> (const <a class="code" href="structDBusString.html">DBusString</a> *username,
<a name="l00114"></a>00114 <a class="code" href="structDBusString.html">DBusString</a> *homedir);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusInternalsUtils.html#gabdd1dc47f44e3d6702c86c68da9a0173" title="Gets the home directory for the given user.">_dbus_homedir_from_uid</a> (<a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid,
<a name="l00117"></a>00117 <a class="code" href="structDBusString.html">DBusString</a> *homedir);
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <a class="code" href="group__DBusMacros.html#gae4a9263a43f8220f6e1c0fd07cf6e59a" title="Macro used after declaring functions in the D-Bus header files.">DBUS_END_DECLS</a>
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_USERDB_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:32 for D-Bus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>