git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-vendor.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>The lglVendor Structure</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
   8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
   9 <link rel="prev" href="libglabels-3.0-category.html" title="The lglCategory Structure">
  10 <link rel="next" href="ch02.html" title="Working Directly With LibGlabels XML">
  11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libglabels-3.0-category.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">LibGlabels 3.0 Reference Manual</th>
  21 <td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libglabels-3.0-vendor.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-vendor.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-vendor"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libglabels-3.0-vendor.top_of_page"></a>The lglVendor Structure</span></h2>
  34 <p>The lglVendor Structure — Vendor definitions</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-vendor.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-vendor.h&gt;
  42
  43 struct              <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor">lglVendor</a>;
  44 <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *         <a class="link" href="libglabels-3.0-vendor.html#lgl-vendor-new" title="lgl_vendor_new ()">lgl_vendor_new</a>                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
  45 <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *         <a class="link" href="libglabels-3.0-vendor.html#lgl-vendor-dup" title="lgl_vendor_dup ()">lgl_vendor_dup</a>                      (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> *orig</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-vendor.html#lgl-vendor-free" title="lgl_vendor_free ()">lgl_vendor_free</a>                     (<em class="parameter"><code><a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> *vendor</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="libglabels-3.0-vendor.description"></a><h2>Description</h2>
  51 <p>
  52 This section describes a structure for representing vendor data.
  53 </p>
  54 </div>
  55 <div class="refsect1">
  56 <a name="libglabels-3.0-vendor.details"></a><h2>Details</h2>
  57 <div class="refsect2">
  58 <a name="lglVendor"></a><h3>struct lglVendor</h3>
  59 <pre class="programlisting">struct lglVendor {
  60         gchar               *name;           /* Vendor name */
  61         gchar               *url;            /* Vendor URL */
  62 };
  63 </pre>
  64 <p>
  65 This structure defines a vendor.
  66 </p>
  67 <div class="variablelist"><table border="0">
  68 <col align="left" valign="top">
  69 <tbody>
  70 <tr>
  71 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglVendor.name"></a>name</code></em>;</span></p></td>
  72 <td>Vendor name.  (e.g. "Avery")</td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglVendor.url"></a>url</code></em>;</span></p></td>
  76 <td>URL to vendor website</td>
  77 </tr>
  78 </tbody>
  79 </table></div>
  80 </div>
  81 <hr>
  82 <div class="refsect2">
  83 <a name="lgl-vendor-new"></a><h3>lgl_vendor_new ()</h3>
  84 <pre class="programlisting"><a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *         lgl_vendor_new                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
  85 <p>
  86 Allocates and constructs a new <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.
  87 </p>
  88 <div class="variablelist"><table border="0">
  89 <col align="left" valign="top">
  90 <tbody>
  91 <tr>
  92 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
  93 <td>Localized name of vendor.</td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  97 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.</td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="lgl-vendor-dup"></a><h3>lgl_vendor_dup ()</h3>
 105 <pre class="programlisting"><a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *         lgl_vendor_dup                      (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> *orig</code></em>);</pre>
 106 <p>
 107 Duplicates an existing <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.
 108 </p>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><span class="term"><em class="parameter"><code>orig</code></em> :</span></p></td>
 114 <td>
 115 <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure to be duplicated.</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 119 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.</td>
 120 </tr>
 121 </tbody>
 122 </table></div>
 123 </div>
 124 <hr>
 125 <div class="refsect2">
 126 <a name="lgl-vendor-free"></a><h3>lgl_vendor_free ()</h3>
 127 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_vendor_free                     (<em class="parameter"><code><a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> *vendor</code></em>);</pre>
 128 <p>
 129 Free all memory associated with an existing <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.
 130 </p>
 131 <div class="variablelist"><table border="0">
 132 <col align="left" valign="top">
 133 <tbody><tr>
 134 <td><p><span class="term"><em class="parameter"><code>vendor</code></em> :</span></p></td>
 135 <td>pointer to <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure to be freed.</td>
 136 </tr></tbody>
 137 </table></div>
 138 </div>
 139 </div>
 140 </div>
 141 <div class="footer">
 142 <hr>
 143           Generated by GTK-Doc V1.17</div>
 144 </body>
 145 </html>