<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="PackageKit-pk-package-obj">
<refmeta>
<refentrytitle role="top_of_page" id="PackageKit-pk-package-obj.top_of_page">pk-package-obj</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PACKAGEKIT Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>pk-package-obj</refname>
<refpurpose>A cached Package structure</refpurpose>
</refnamediv>

<refsynopsisdiv id="PackageKit-pk-package-obj.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="PkPackageObj">PkPackageObj</link>;
<link linkend="PkPackageObj">PkPackageObj</link> *      <link linkend="pk-package-obj-new">pk_package_obj_new</link>                  (<link linkend="PkInfoEnum">PkInfoEnum</link> info,
                                                         const <link linkend="PkPackageId">PkPackageId</link> *id,
                                                         const <link linkend="gchar">gchar</link> *summary);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-obj-free">pk_package_obj_free</link>                 (<link linkend="PkPackageObj">PkPackageObj</link> *obj);
<link linkend="PkPackageObj">PkPackageObj</link> *      <link linkend="pk-package-obj-copy">pk_package_obj_copy</link>                 (const <link linkend="PkPackageObj">PkPackageObj</link> *obj);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-obj-equal">pk_package_obj_equal</link>                (const <link linkend="PkPackageObj">PkPackageObj</link> *obj1,
                                                         const <link linkend="PkPackageObj">PkPackageObj</link> *obj2);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-obj-equal-fuzzy-arch">pk_package_obj_equal_fuzzy_arch</link>     (const <link linkend="PkPackageObj">PkPackageObj</link> *obj1,
                                                         const <link linkend="PkPackageObj">PkPackageObj</link> *obj2);
<link linkend="gchar">gchar</link> *             <link linkend="pk-package-obj-to-string">pk_package_obj_to_string</link>            (const <link linkend="PkPackageObj">PkPackageObj</link> *obj);
<link linkend="PkPackageObj">PkPackageObj</link> *      <link linkend="pk-package-obj-from-string">pk_package_obj_from_string</link>          (const <link linkend="gchar">gchar</link> *text);
</synopsis>
</refsynopsisdiv>









<refsect1 id="PackageKit-pk-package-obj.description" role="desc">
<title role="desc.title">Description</title>
<para>
These provide a way to query and store a single package.</para>
<para>
</para>
</refsect1>

<refsect1 id="PackageKit-pk-package-obj.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PkPackageObj" role="struct">
<title>PkPackageObj</title>
<indexterm zone="PkPackageObj"><primary sortas="PkPackageObj">PkPackageObj</primary></indexterm><programlisting>typedef struct {
	PkInfoEnum		 info;
	PkPackageId		*id;
	gchar			*summary;
} PkPackageObj;
</programlisting>
<para>
A cached store for the complete Package object</para>
<para>
</para></refsect2>
<refsect2 id="pk-package-obj-new" role="function">
<title>pk_package_obj_new ()</title>
<indexterm zone="pk-package-obj-new"><primary sortas="pk_package_obj_new">pk_package_obj_new</primary></indexterm><programlisting><link linkend="PkPackageObj">PkPackageObj</link> *      pk_package_obj_new                  (<link linkend="PkInfoEnum">PkInfoEnum</link> info,
                                                         const <link linkend="PkPackageId">PkPackageId</link> *id,
                                                         const <link linkend="gchar">gchar</link> *summary);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-free" role="function">
<title>pk_package_obj_free ()</title>
<indexterm zone="pk-package-obj-free"><primary sortas="pk_package_obj_free">pk_package_obj_free</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_obj_free                 (<link linkend="PkPackageObj">PkPackageObj</link> *obj);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-copy" role="function">
<title>pk_package_obj_copy ()</title>
<indexterm zone="pk-package-obj-copy"><primary sortas="pk_package_obj_copy">pk_package_obj_copy</primary></indexterm><programlisting><link linkend="PkPackageObj">PkPackageObj</link> *      pk_package_obj_copy                 (const <link linkend="PkPackageObj">PkPackageObj</link> *obj);</programlisting>
<para>
Copy a PkPackageObj</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-equal" role="function">
<title>pk_package_obj_equal ()</title>
<indexterm zone="pk-package-obj-equal"><primary sortas="pk_package_obj_equal">pk_package_obj_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_obj_equal                (const <link linkend="PkPackageObj">PkPackageObj</link> *obj1,
                                                         const <link linkend="PkPackageObj">PkPackageObj</link> *obj2);</programlisting>
<para>
Only compares the package_id's and the info enum</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj1</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>obj2</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-equal-fuzzy-arch" role="function">
<title>pk_package_obj_equal_fuzzy_arch ()</title>
<indexterm zone="pk-package-obj-equal-fuzzy-arch"><primary sortas="pk_package_obj_equal_fuzzy_arch">pk_package_obj_equal_fuzzy_arch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_obj_equal_fuzzy_arch     (const <link linkend="PkPackageObj">PkPackageObj</link> *obj1,
                                                         const <link linkend="PkPackageObj">PkPackageObj</link> *obj2);</programlisting>
<para>
Only compares the package_id's and the info enum, being a bit fuzzy on the arch</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj1</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>obj2</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-to-string" role="function">
<title>pk_package_obj_to_string ()</title>
<indexterm zone="pk-package-obj-to-string"><primary sortas="pk_package_obj_to_string">pk_package_obj_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             pk_package_obj_to_string            (const <link linkend="PkPackageObj">PkPackageObj</link> *obj);</programlisting>
<para>
Convert a PkPackageObj to a string</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-obj-from-string" role="function">
<title>pk_package_obj_from_string ()</title>
<indexterm zone="pk-package-obj-from-string"><primary sortas="pk_package_obj_from_string">pk_package_obj_from_string</primary></indexterm><programlisting><link linkend="PkPackageObj">PkPackageObj</link> *      pk_package_obj_from_string          (const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Convert a PkPackageObj from a string</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
