| Current File : //proc/self/root/kunden/usr/share/gtk-doc/html/polkit-1/PolkitIdentity.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PolkitIdentity: polkit Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="polkit Reference Manual">
<link rel="up" href="Identities.html" title="Identities">
<link rel="prev" href="Identities.html" title="Identities">
<link rel="next" href="PolkitUnixUser.html" title="PolkitUnixUser">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#PolkitIdentity.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#PolkitIdentity.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#PolkitIdentity.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#PolkitIdentity.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Identities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Identities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="PolkitUnixUser.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PolkitIdentity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PolkitIdentity.top_of_page"></a>PolkitIdentity</span></h2>
<p>PolkitIdentity — Type for representing identities</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PolkitIdentity.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="PolkitIdentity.html#polkit-identity-hash" title="polkit_identity_hash ()">polkit_identity_hash</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PolkitIdentity.html#polkit-identity-equal" title="polkit_identity_equal ()">polkit_identity_equal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PolkitIdentity.html#polkit-identity-to-string" title="polkit_identity_to_string ()">polkit_identity_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="returnvalue">PolkitIdentity</span></a> *
</td>
<td class="function_name">
<a class="link" href="PolkitIdentity.html#polkit-identity-from-string" title="polkit_identity_from_string ()">polkit_identity_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitIdentity.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="PolkitIdentity.html#PolkitIdentity-struct" title="PolkitIdentity">PolkitIdentity</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PolkitIdentity.html#PolkitIdentityIface" title="struct PolkitIdentityIface">PolkitIdentityIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PolkitIdentity.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> PolkitIdentity
</pre>
</div>
<div class="refsect1">
<a name="PolkitIdentity.prerequisites"></a><h2>Prerequisites</h2>
<p>
PolkitIdentity requires
GObject.</p>
</div>
<div class="refsect1">
<a name="PolkitIdentity.implementations"></a><h2>Known Implementations</h2>
<p>
PolkitIdentity is implemented by
<a class="link" href="PolkitUnixGroup.html" title="PolkitUnixGroup">PolkitUnixGroup</a>, <a class="link" href="PolkitUnixNetgroup.html" title="PolkitUnixNetgroup">PolkitUnixNetgroup</a> and <a class="link" href="PolkitUnixUser.html" title="PolkitUnixUser">PolkitUnixUser</a>.</p>
</div>
<div class="refsect1">
<a name="PolkitIdentity.description"></a><h2>Description</h2>
<p><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> is an abstract type for representing one or more
identities.</p>
</div>
<div class="refsect1">
<a name="PolkitIdentity.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="polkit-identity-hash"></a><h3>polkit_identity_hash ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
polkit_identity_hash (<em class="parameter"><code><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> *identity</code></em>);</pre>
<p>Gets a hash code for <em class="parameter"><code>identity</code></em>
that can be used with e.g. <code class="function">g_hash_table_new()</code>.</p>
<div class="refsect3">
<a name="polkit-identity-hash.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-identity-hash.returns"></a><h4>Returns</h4>
<p> A hash code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-identity-equal"></a><h3>polkit_identity_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
polkit_identity_equal (<em class="parameter"><code><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> *a</code></em>,
<em class="parameter"><code><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> *b</code></em>);</pre>
<p>Checks if <em class="parameter"><code>a</code></em>
and <em class="parameter"><code>b</code></em>
are equal, ie. represent the same identity.</p>
<p>This function can be used in e.g. <code class="function">g_hash_table_new()</code>.</p>
<div class="refsect3">
<a name="polkit-identity-equal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>b</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-identity-equal.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>a</code></em>
and <em class="parameter"><code>b</code></em>
are equal, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-identity-to-string"></a><h3>polkit_identity_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
polkit_identity_to_string (<em class="parameter"><code><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> *identity</code></em>);</pre>
<p>Serializes <em class="parameter"><code>identity</code></em>
to a string that can be used in
<a class="link" href="PolkitIdentity.html#polkit-identity-from-string" title="polkit_identity_from_string ()"><code class="function">polkit_identity_from_string()</code></a>.</p>
<div class="refsect3">
<a name="polkit-identity-to-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p>A <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-identity-to-string.returns"></a><h4>Returns</h4>
<p> A string representing <em class="parameter"><code>identity</code></em>
. Free with <code class="function">g_free()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-identity-from-string"></a><h3>polkit_identity_from_string ()</h3>
<pre class="programlisting"><a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="returnvalue">PolkitIdentity</span></a> *
polkit_identity_from_string (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates an object from <em class="parameter"><code>str</code></em>
that implements the <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>
interface.</p>
<div class="refsect3">
<a name="polkit-identity-from-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>A string obtained from <a class="link" href="PolkitIdentity.html#polkit-identity-to-string" title="polkit_identity_to_string ()"><code class="function">polkit_identity_to_string()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="polkit-identity-from-string.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> or <code class="literal">NULL</code>
if <em class="parameter"><code>error</code></em>
is set. Free with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="PolkitIdentity.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PolkitIdentity-struct"></a><h3>PolkitIdentity</h3>
<pre class="programlisting">typedef struct _PolkitIdentity PolkitIdentity;</pre>
<p>Generic type for all objects that can be used as identities.</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitIdentityIface"></a><h3>struct PolkitIdentityIface</h3>
<pre class="programlisting">struct PolkitIdentityIface {
GTypeInterface parent_iface;
guint (*hash) (PolkitIdentity *identity);
gboolean (*equal) (PolkitIdentity *a,
PolkitIdentity *b);
gchar * (*to_string) (PolkitIdentity *identity);
};
</pre>
<p>An interface for identities.</p>
<div class="refsect3">
<a name="PolkitIdentityIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="PolkitIdentityIface.parent-iface"></a>parent_iface</code></em>;</p></td>
<td class="struct_member_description"><p>The parent interface.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="PolkitIdentityIface.hash"></a>hash</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets a hash value for a <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="PolkitIdentityIface.equal"></a>equal</code></em> ()</p></td>
<td class="struct_member_description"><p>Checks if two <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a>s are equal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="PolkitIdentityIface.to-string"></a>to_string</code></em> ()</p></td>
<td class="struct_member_description"><p>Serializes a <a class="link" href="PolkitIdentity.html" title="PolkitIdentity"><span class="type">PolkitIdentity</span></a> to a string that can be
used in <a class="link" href="PolkitIdentity.html#polkit-identity-from-string" title="polkit_identity_from_string ()"><code class="function">polkit_identity_from_string()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>