<!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"/>
<title>libgutenprint API Reference: printer</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference <span id="projectnumber">5.2.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">printer</div> </div>
</div>
<div class="contents">
<p>The printer type represents a printer model.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__printfuncs__t.html">stp_printfuncs_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__family.html">stp_family</a></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct stp_printer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The printer opaque data type (representation of printer model). <a href="#gacddc2ce7fa4e0a68fcc30c123503738f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structstp__family.html">stp_family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga66a5e7cf2b1743a46bd78cb851e1d0a4">stp_family_t</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga6a76f8f76106eddd51af4b1593b4f3af">stp_printer_model_count</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available printer models. <a href="#ga6a76f8f76106eddd51af4b1593b4f3af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga440501ca226e0a9ac1335c7e52ee55a6">stp_get_printer_by_index</a> (int idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model by its index number. <a href="#ga440501ca226e0a9ac1335c7e52ee55a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga6bd5abd876100c17fc9029659fed92f4">stp_get_printer_by_long_name</a> (const char *long_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model by its long (translated) name. <a href="#ga6bd5abd876100c17fc9029659fed92f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gae45de9ef94fb609c2a54f1d80144552e">stp_get_printer_by_driver</a> (const char *driver)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model by its short name. <a href="#gae45de9ef94fb609c2a54f1d80144552e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gadce65b83e3dd0ffcb75591ed3ba81155">stp_get_printer_by_device_id</a> (const char *device_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model by its IEEE 1284 device ID. <a href="#gadce65b83e3dd0ffcb75591ed3ba81155"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gacd449b7863a5fcddb6bdb602079448f8">stp_get_printer_by_foomatic_id</a> (const char *foomatic_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model by its foomatic ID. <a href="#gacd449b7863a5fcddb6bdb602079448f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gac649c4b3d0a93f26f99deb4b081305c1">stp_get_printer</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the printer model from a vars object. <a href="#gac649c4b3d0a93f26f99deb4b081305c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga41094e69b71eb930e770bd2cf8bbf795">stp_get_printer_index_by_driver</a> (const char *driver)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the printer index number from the printer model short (driver) name. <a href="#ga41094e69b71eb930e770bd2cf8bbf795"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga11804fb9b8d87ed1f2a3acbd39f5f85a">stp_printer_get_long_name</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's long (translated) name. <a href="#ga11804fb9b8d87ed1f2a3acbd39f5f85a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gac345b8cf8cd78da98fdb4c6b2d9cf7ca">stp_printer_get_driver</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's short (driver) name. <a href="#gac345b8cf8cd78da98fdb4c6b2d9cf7ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga7bbd6440baa533d99616eccb5f449354">stp_printer_get_device_id</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's IEEE 1284 device ID, if known. <a href="#ga7bbd6440baa533d99616eccb5f449354"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga487b74bf101a842f30b5941b8db4769a">stp_printer_get_family</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's family name. <a href="#ga487b74bf101a842f30b5941b8db4769a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gab99dd05c42aed848d1567f2b346fb4f4">stp_printer_get_manufacturer</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's manufacturer's name. <a href="#gab99dd05c42aed848d1567f2b346fb4f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gaac52d241cc86a10965046afc0a8c8a41">stp_printer_get_foomatic_id</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's foomatic ID. <a href="#gaac52d241cc86a10965046afc0a8c8a41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gaae84d3fb263c4a171b7b63b6d93a940e">stp_printer_get_model</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a printer model's model number. <a href="#gaae84d3fb263c4a171b7b63b6d93a940e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga4f6859e0f21ed2062075d6b9f680a202">stp_printer_get_defaults</a> (const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default vars for a particular printer model. <a href="#ga4f6859e0f21ed2062075d6b9f680a202"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gaf5084888feed9878811ac491cb5313ee">stp_set_printer_defaults</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a vars object to use a particular driver, and set the parameters to their defaults. <a href="#gaf5084888feed9878811ac491cb5313ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gac2ed6f27e4db29ceaa74a1b9bd6a78cf">stp_set_printer_defaults_soft</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a vars object to use a particular driver, and set any unset parameters to their defaults. <a href="#gac2ed6f27e4db29ceaa74a1b9bd6a78cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga6065874cbb246875925e14d8801898cc">stp_print</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the image. <a href="#ga6065874cbb246875925e14d8801898cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga31ef7bcc34dda5d3fd46b2d04fcb0c64">stp_start_job</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a print job. <a href="#ga31ef7bcc34dda5d3fd46b2d04fcb0c64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gae61d056dd504facc72ff56d7f16eb23c">stp_end_job</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="structstp__image.html">stp_image_t</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End a print job. <a href="#gae61d056dd504facc72ff56d7f16eb23c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="string-list_8h.html#a5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#gaae7a50e6175eed1b84d2e20c924b33ca">stp_get_external_options</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve options that need to be passed to the underlying print system. <a href="#gaae7a50e6175eed1b84d2e20c924b33ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga2057c5fcfc31d8b4cf7f3291cf3c0cf4">stp_get_model_id</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga5b5cb603c9432c03ea459b57a2039bdc">stp_verify_printer_params</a> (<a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga1c6d389f49a185ca24546107bd6f4993">stp_family_register</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *family)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga67e5c18254f7ad0b0fd77b4cc2265405">stp_family_unregister</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *family)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga381f3a4f132a00d6d2e2a9b54f9ed675">stp_initialize_printer_defaults</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga09bf7aebf0385f7b5aac537a13b6e3ed">stp_printer_list_parameters</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga07bc634c85950526155b711aac42c6a0">stp_printer_describe_parameter</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name, <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__printer.html#ga50b48bab8d6d1734c3a0f6622d65582e">stp_describe_output</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The printer type represents a printer model. </p>
<p>A particular printer model must selected in order to be able to print. Each printer model provides default print options through a default vars object. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga66a5e7cf2b1743a46bd78cb851e1d0a4"></a><!-- doxytag: member="printers.h::stp_family_t" ref="ga66a5e7cf2b1743a46bd78cb851e1d0a4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structstp__family.html">stp_family</a> <a class="el" href="structstp__family.html">stp_family_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gacddc2ce7fa4e0a68fcc30c123503738f"></a><!-- doxytag: member="printers.h::stp_printer_t" ref="gacddc2ce7fa4e0a68fcc30c123503738f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct stp_printer <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The printer opaque data type (representation of printer model). </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga50b48bab8d6d1734c3a0f6622d65582e"></a><!-- doxytag: member="printers.h::stp_describe_output" ref="ga50b48bab8d6d1734c3a0f6622d65582e" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_describe_output </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gae61d056dd504facc72ff56d7f16eb23c"></a><!-- doxytag: member="printers.h::stp_end_job" ref="gae61d056dd504facc72ff56d7f16eb23c" args="(const stp_vars_t *v, stp_image_t *image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_end_job </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__image.html">stp_image_t</a> * </td>
<td class="paramname"><em>image</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End a print job. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
<tr><td class="paramname">image</td><td>the image to print. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1c6d389f49a185ca24546107bd6f4993"></a><!-- doxytag: member="printers.h::stp_family_register" ref="ga1c6d389f49a185ca24546107bd6f4993" args="(stp_list_t *family)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_family_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>family</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga67e5c18254f7ad0b0fd77b4cc2265405"></a><!-- doxytag: member="printers.h::stp_family_unregister" ref="ga67e5c18254f7ad0b0fd77b4cc2265405" args="(stp_list_t *family)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_family_unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td>
<td class="paramname"><em>family</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gaae7a50e6175eed1b84d2e20c924b33ca"></a><!-- doxytag: member="printers.h::stp_get_external_options" ref="gaae7a50e6175eed1b84d2e20c924b33ca" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="string-list_8h.html#a5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a>* stp_get_external_options </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve options that need to be passed to the underlying print system. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>list of options in a string list ('name' is the name of the option; 'text' is the value it takes on). NULL return means no external options are required. User must stp_string_list_destroy the list after use. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2057c5fcfc31d8b4cf7f3291cf3c0cf4"></a><!-- doxytag: member="printers.h::stp_get_model_id" ref="ga2057c5fcfc31d8b4cf7f3291cf3c0cf4" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_get_model_id </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gac649c4b3d0a93f26f99deb4b081305c1"></a><!-- doxytag: member="printers.h::stp_get_printer" ref="gac649c4b3d0a93f26f99deb4b081305c1" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the printer model from a vars object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="gadce65b83e3dd0ffcb75591ed3ba81155"></a><!-- doxytag: member="printers.h::stp_get_printer_by_device_id" ref="gadce65b83e3dd0ffcb75591ed3ba81155" args="(const char *device_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer_by_device_id </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>device_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model by its IEEE 1284 device ID. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">device_id</td><td>the printer model's device ID. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="gae45de9ef94fb609c2a54f1d80144552e"></a><!-- doxytag: member="printers.h::stp_get_printer_by_driver" ref="gae45de9ef94fb609c2a54f1d80144552e" args="(const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer_by_driver </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model by its short name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>the printer model's short (driver) name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="gacd449b7863a5fcddb6bdb602079448f8"></a><!-- doxytag: member="printers.h::stp_get_printer_by_foomatic_id" ref="gacd449b7863a5fcddb6bdb602079448f8" args="(const char *foomatic_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer_by_foomatic_id </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>foomatic_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model by its foomatic ID. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">foomatic_id</td><td>the printer model's foomatic ID </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga440501ca226e0a9ac1335c7e52ee55a6"></a><!-- doxytag: member="printers.h::stp_get_printer_by_index" ref="ga440501ca226e0a9ac1335c7e52ee55a6" args="(int idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer_by_index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model by its index number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>the index number. This must not be greater than (total number of printers - 1). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6bd5abd876100c17fc9029659fed92f4"></a><!-- doxytag: member="printers.h::stp_get_printer_by_long_name" ref="ga6bd5abd876100c17fc9029659fed92f4" args="(const char *long_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a>* stp_get_printer_by_long_name </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>long_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model by its long (translated) name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">long_name</td><td>the printer model's long (translated) name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the printer model, or NULL on failure. The pointer should not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga41094e69b71eb930e770bd2cf8bbf795"></a><!-- doxytag: member="printers.h::stp_get_printer_index_by_driver" ref="ga41094e69b71eb930e770bd2cf8bbf795" args="(const char *driver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_get_printer_index_by_driver </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the printer index number from the printer model short (driver) name. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>There should never be any need to use this function. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>the printer model's short (driver) name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the index number, or -1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga381f3a4f132a00d6d2e2a9b54f9ed675"></a><!-- doxytag: member="printers.h::stp_initialize_printer_defaults" ref="ga381f3a4f132a00d6d2e2a9b54f9ed675" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_initialize_printer_defaults </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6065874cbb246875925e14d8801898cc"></a><!-- doxytag: member="printers.h::stp_print" ref="ga6065874cbb246875925e14d8801898cc" args="(const stp_vars_t *v, stp_image_t *image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_print </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__image.html">stp_image_t</a> * </td>
<td class="paramname"><em>image</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print the image. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>stp_job_start() must be called prior to the first call to this function. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
<tr><td class="paramname">image</td><td>the image to print. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on failure, 1 on success, 2 on abort requested by the driver. </dd></dl>
</div>
</div>
<a class="anchor" id="ga07bc634c85950526155b711aac42c6a0"></a><!-- doxytag: member="printers.h::stp_printer_describe_parameter" ref="ga07bc634c85950526155b711aac42c6a0" args="(const stp_vars_t *v, const char *name, stp_parameter_t *description)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_printer_describe_parameter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td>
<td class="paramname"><em>description</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga4f6859e0f21ed2062075d6b9f680a202"></a><!-- doxytag: member="printers.h::stp_printer_get_defaults" ref="ga4f6859e0f21ed2062075d6b9f680a202" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a>* stp_printer_get_defaults </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the default vars for a particular printer model. </p>
<p>The default vars should be copied to a new vars object and customised prior to printing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the printer model's default vars. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7bbd6440baa533d99616eccb5f449354"></a><!-- doxytag: member="printers.h::stp_printer_get_device_id" ref="ga7bbd6440baa533d99616eccb5f449354" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_device_id </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's IEEE 1284 device ID, if known. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the IEEE 1284 device ID, or NULL if not known. </dd></dl>
</div>
</div>
<a class="anchor" id="gac345b8cf8cd78da98fdb4c6b2d9cf7ca"></a><!-- doxytag: member="printers.h::stp_printer_get_driver" ref="gac345b8cf8cd78da98fdb4c6b2d9cf7ca" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_driver </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's short (driver) name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the short name (should never be freed). </dd></dl>
</div>
</div>
<a class="anchor" id="ga487b74bf101a842f30b5941b8db4769a"></a><!-- doxytag: member="printers.h::stp_printer_get_family" ref="ga487b74bf101a842f30b5941b8db4769a" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_family </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's family name. </p>
<p>The family name is the name of the modular "family" driver this model uses. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the family name (should never be freed). </dd></dl>
</div>
</div>
<a class="anchor" id="gaac52d241cc86a10965046afc0a8c8a41"></a><!-- doxytag: member="printers.h::stp_printer_get_foomatic_id" ref="gaac52d241cc86a10965046afc0a8c8a41" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_foomatic_id </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's foomatic ID. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the foomatic ID or NULL (should never be freed) </dd></dl>
</div>
</div>
<a class="anchor" id="ga11804fb9b8d87ed1f2a3acbd39f5f85a"></a><!-- doxytag: member="printers.h::stp_printer_get_long_name" ref="ga11804fb9b8d87ed1f2a3acbd39f5f85a" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_long_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's long (translated) name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the long name (should never be freed). </dd></dl>
</div>
</div>
<a class="anchor" id="gab99dd05c42aed848d1567f2b346fb4f4"></a><!-- doxytag: member="printers.h::stp_printer_get_manufacturer" ref="gab99dd05c42aed848d1567f2b346fb4f4" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* stp_printer_get_manufacturer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's manufacturer's name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the manufacturer's name (should never be freed). </dd></dl>
</div>
</div>
<a class="anchor" id="gaae84d3fb263c4a171b7b63b6d93a940e"></a><!-- doxytag: member="printers.h::stp_printer_get_model" ref="gaae84d3fb263c4a171b7b63b6d93a940e" args="(const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_printer_get_model </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a printer model's model number. </p>
<p>The model number is used internally by the "family" driver module, and has no meaning out of that context. It bears no relation to the model name/number actually found on the printer itself. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the model number. </dd></dl>
</div>
</div>
<a class="anchor" id="ga09bf7aebf0385f7b5aac537a13b6e3ed"></a><!-- doxytag: member="printers.h::stp_printer_list_parameters" ref="ga09bf7aebf0385f7b5aac537a13b6e3ed" args="(const stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vars.html#ga40c1035f88ac38d77eddb65195b28595">stp_parameter_list_t</a> stp_printer_list_parameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga6a76f8f76106eddd51af4b1593b4f3af"></a><!-- doxytag: member="printers.h::stp_printer_model_count" ref="ga6a76f8f76106eddd51af4b1593b4f3af" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_printer_model_count </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of available printer models. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of printer models. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf5084888feed9878811ac491cb5313ee"></a><!-- doxytag: member="printers.h::stp_set_printer_defaults" ref="gaf5084888feed9878811ac491cb5313ee" args="(stp_vars_t *v, const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_set_printer_defaults </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a vars object to use a particular driver, and set the parameters to their defaults. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac2ed6f27e4db29ceaa74a1b9bd6a78cf"></a><!-- doxytag: member="printers.h::stp_set_printer_defaults_soft" ref="gac2ed6f27e4db29ceaa74a1b9bd6a78cf" args="(stp_vars_t *v, const stp_printer_t *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_set_printer_defaults_soft </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__printer.html#gacddc2ce7fa4e0a68fcc30c123503738f">stp_printer_t</a> * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a vars object to use a particular driver, and set any unset parameters to their defaults. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
<tr><td class="paramname">p</td><td>the printer model to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga31ef7bcc34dda5d3fd46b2d04fcb0c64"></a><!-- doxytag: member="printers.h::stp_start_job" ref="ga31ef7bcc34dda5d3fd46b2d04fcb0c64" args="(const stp_vars_t *v, stp_image_t *image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_start_job </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstp__image.html">stp_image_t</a> * </td>
<td class="paramname"><em>image</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start a print job. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>This function must be called prior to the first call to <a class="el" href="group__printer.html#ga6065874cbb246875925e14d8801898cc" title="Print the image.">stp_print()</a>. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vars to use. </td></tr>
<tr><td class="paramname">image</td><td>the image to print. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5b5cb603c9432c03ea459b57a2039bdc"></a><!-- doxytag: member="printers.h::stp_verify_printer_params" ref="ga5b5cb603c9432c03ea459b57a2039bdc" args="(stp_vars_t *v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_verify_printer_params </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
