diff options
| author | Roger Leigh <rleigh@debian.org> | 2008-10-26 16:11:41 +0000 |
|---|---|---|
| committer | Roger Leigh <rleigh@debian.org> | 2008-10-26 16:11:41 +0000 |
| commit | dfae5860833782af557deb35e286d7e186fe3cf5 (patch) | |
| tree | e3b4282ae08e120f78cd0c097f7cb3b570e94da2 /doc/gutenprint/html/group__vars.html | |
| parent | 3b59bb0a607ec27ea60f07d1cd5d1bbb4483c832 (diff) | |
Imported Upstream version 4.3.99+cvs20050702
Diffstat (limited to 'doc/gutenprint/html/group__vars.html')
| -rw-r--r-- | doc/gutenprint/html/group__vars.html | 6594 |
1 files changed, 6594 insertions, 0 deletions
diff --git a/doc/gutenprint/html/group__vars.html b/doc/gutenprint/html/group__vars.html new file mode 100644 index 0000000..468533e --- /dev/null +++ b/doc/gutenprint/html/group__vars.html @@ -0,0 +1,6594 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>libgutenprint API Reference: vars</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.3-20050530 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> +<h1>vars</h1>The vars data type contains all the information about a print job, this includes information such as the printer model, paper size, print resolution etc. +<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__raw__t.html">stp_raw_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Raw parameter. <a href="structstp__raw__t.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__double__bound__t.html">stp_double_bound_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">double_bound (range) parameter. <a href="structstp__double__bound__t.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">int_bound (range) parameter. <a href="structstp__int__bound__t.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter description. <a href="structstp__parameter__t.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef stp_vars </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga0">stp_vars_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The vars opaque data type. <a href="#ga0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The parameter_list opaque data type. <a href="#ga1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The constant parameter_list opaque data type. <a href="#ga2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> )(void *data, const char *buffer, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Output function supplied by the calling application. <a href="#ga3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga4">stp_copy_data_func_t</a> )(void *)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga5">stp_free_data_func_t</a> )(void *)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef stp_compdata </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga6">compdata_t</a></td></tr> + +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga132">stp_parameter_type_t</a> { <br> + <a class="el" href="group__vars.html#gga132a7">STP_PARAMETER_TYPE_STRING_LIST</a>, +<a class="el" href="group__vars.html#gga132a8">STP_PARAMETER_TYPE_INT</a>, +<a class="el" href="group__vars.html#gga132a9">STP_PARAMETER_TYPE_BOOLEAN</a>, +<a class="el" href="group__vars.html#gga132a10">STP_PARAMETER_TYPE_DOUBLE</a>, +<br> + <a class="el" href="group__vars.html#gga132a11">STP_PARAMETER_TYPE_CURVE</a>, +<a class="el" href="group__vars.html#gga132a12">STP_PARAMETER_TYPE_FILE</a>, +<a class="el" href="group__vars.html#gga132a13">STP_PARAMETER_TYPE_RAW</a>, +<a class="el" href="group__vars.html#gga132a14">STP_PARAMETER_TYPE_ARRAY</a>, +<br> + <a class="el" href="group__vars.html#gga132a15">STP_PARAMETER_TYPE_DIMENSION</a>, +<a class="el" href="group__vars.html#gga132a16">STP_PARAMETER_TYPE_INVALID</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter types. <a href="group__vars.html#ga132">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga133">stp_parameter_class_t</a> { <a class="el" href="group__vars.html#gga133a17">STP_PARAMETER_CLASS_FEATURE</a>, +<a class="el" href="group__vars.html#gga133a18">STP_PARAMETER_CLASS_OUTPUT</a>, +<a class="el" href="group__vars.html#gga133a19">STP_PARAMETER_CLASS_CORE</a>, +<a class="el" href="group__vars.html#gga133a20">STP_PARAMETER_CLASS_INVALID</a> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter class. <a href="group__vars.html#ga133">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga134">stp_parameter_level_t</a> { <br> + <a class="el" href="group__vars.html#gga134a21">STP_PARAMETER_LEVEL_BASIC</a>, +<a class="el" href="group__vars.html#gga134a22">STP_PARAMETER_LEVEL_ADVANCED</a>, +<a class="el" href="group__vars.html#gga134a23">STP_PARAMETER_LEVEL_ADVANCED1</a>, +<a class="el" href="group__vars.html#gga134a24">STP_PARAMETER_LEVEL_ADVANCED2</a>, +<br> + <a class="el" href="group__vars.html#gga134a25">STP_PARAMETER_LEVEL_ADVANCED3</a>, +<a class="el" href="group__vars.html#gga134a26">STP_PARAMETER_LEVEL_ADVANCED4</a>, +<a class="el" href="group__vars.html#gga134a27">STP_PARAMETER_LEVEL_INTERNAL</a>, +<a class="el" href="group__vars.html#gga134a28">STP_PARAMETER_LEVEL_EXTERNAL</a>, +<br> + <a class="el" href="group__vars.html#gga134a29">STP_PARAMETER_LEVEL_INVALID</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter level. <a href="group__vars.html#ga134">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> { <a class="el" href="group__vars.html#gga135a30">STP_PARAMETER_INACTIVE</a>, +<a class="el" href="group__vars.html#gga135a31">STP_PARAMETER_DEFAULTED</a>, +<a class="el" href="group__vars.html#gga135a32">STP_PARAMETER_ACTIVE</a> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter activity. <a href="group__vars.html#ga135">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga136">stp_parameter_verify_t</a> { <a class="el" href="group__vars.html#gga136a33">PARAMETER_BAD</a>, +<a class="el" href="group__vars.html#gga136a34">PARAMETER_OK</a>, +<a class="el" href="group__vars.html#gga136a35">PARAMETER_INACTIVE</a> + }</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga7">stp_vars_create</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new vars object. <a href="#ga7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga8">stp_vars_copy</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *dest, const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *source)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy a vars object. <a href="#ga8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga9">stp_vars_create_copy</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *source)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate a vars object. <a href="#ga9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga10">stp_vars_destroy</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a vars object. <a href="#ga10"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga11">stp_set_driver</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the printer driver. <a href="#ga11"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga12">stp_set_driver_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *val, int bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the printer driver. <a href="#ga12"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga13">stp_get_driver</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the printer driver. <a href="#ga13"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga14">stp_set_color_conversion</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the color conversion routine, if not the default. <a href="#ga14"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga15">stp_set_color_conversion_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *val, int bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the color conversion routine, if not the default. <a href="#ga15"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga16">stp_get_color_conversion</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the color conversion routine. <a href="#ga16"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga17">stp_set_left</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the left edge of the image. <a href="#ga17"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga18">stp_get_left</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the left edge of the image. <a href="#ga18"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga19">stp_set_top</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the top edge of the image. <a href="#ga19"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga20">stp_get_top</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the top edge of the image. <a href="#ga20"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga21">stp_set_width</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the width of the image. <a href="#ga21"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga22">stp_get_width</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the width edge of the image. <a href="#ga22"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga23">stp_set_height</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the height of the image. <a href="#ga23"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga24">stp_get_height</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the height of the image. <a href="#ga24"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga25">stp_set_page_width</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the page width. <a href="#ga25"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga26">stp_get_page_width</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the page width. <a href="#ga26"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga27">stp_set_page_height</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the page height. <a href="#ga27"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga28">stp_get_page_height</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the page height. <a href="#ga28"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga29">stp_set_outfunc</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, <a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function used to print output information. <a href="#ga29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga30">stp_get_outfunc</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the function used to print output information. <a href="#ga30"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga31">stp_set_errfunc</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, <a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function used to print error and diagnostic information. <a href="#ga31"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga32">stp_get_errfunc</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the function used to print output information. <a href="#ga32"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga33">stp_set_outdata</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, void *val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the output data. <a href="#ga33"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga34">stp_get_outdata</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the output data. <a href="#ga34"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga35">stp_set_errdata</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, void *val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error data. <a href="#ga35"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga36">stp_get_errdata</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the error data. <a href="#ga36"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga37">stp_merge_printvars</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *user, const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *print)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Merge defaults for a printer with user-chosen settings. <a href="#ga37"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga38">stp_get_parameter_list</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">List the available parameters for the currently chosen settings. <a href="#ga38"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga39">stp_parameter_list_count</a> (<a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">List the number of available parameters for the currently chosen settings. <a href="#ga39"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga40">stp_parameter_find</a> (<a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> list, const char *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a parameter by its name. <a href="#ga40"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga41">stp_parameter_list_param</a> (<a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> list, size_t item)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a parameter by its index number. <a href="#ga41"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga42">stp_parameter_list_destroy</a> (<a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a parameter_list. <a href="#ga42"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga43">stp_parameter_list_create</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a parameter_list. <a href="#ga43"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga44">stp_parameter_list_add_param</a> (<a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> list, const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *item)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to a parameter_list. <a href="#ga44"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga45">stp_parameter_list_copy</a> (<a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate a parameter_list. <a href="#ga45"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga46">stp_parameter_list_append</a> (<a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> list, <a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> append)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Append one parameter_list to another. <a href="#ga46"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga47">stp_describe_parameter</a> (const <a class="el" href="group__vars.html#ga0">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="mdescLeft"> </td><td class="mdescRight">Describe a parameter in detail. <a href="#ga47"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga48">stp_parameter_description_destroy</a> (<a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *description)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a parameter description. <a href="#ga48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga49">stp_parameter_find_in_settings</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a parameter by its name from a vars object. <a href="#ga49"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga50">stp_set_string_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string parameter. <a href="#ga50"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga51">stp_set_string_parameter_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string parameter. <a href="#ga51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga52">stp_set_file_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a file parameter. <a href="#ga52"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga53">stp_set_file_parameter_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a file parameter. <a href="#ga53"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga54">stp_set_float_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, double value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a float parameter. <a href="#ga54"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga55">stp_set_int_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an integer parameter. <a href="#ga55"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga56">stp_set_dimension_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a dimension parameter. <a href="#ga56"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga57">stp_set_boolean_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a boolean parameter. <a href="#ga57"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga58">stp_set_curve_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const <a class="el" href="group__curve.html#ga0">stp_curve_t</a> *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a curve parameter. <a href="#ga58"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga59">stp_set_array_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const <a class="el" href="group__array.html#ga0">stp_array_t</a> *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an array parameter. <a href="#ga59"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga60">stp_set_raw_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const void *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a raw parameter. <a href="#ga60"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga61">stp_scale_float_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, double scale)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply the value of a float parameter by a scaling factor. <a href="#ga61"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga62">stp_set_default_string_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default string parameter. <a href="#ga62"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga63">stp_set_default_string_parameter_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default string parameter. <a href="#ga63"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga64">stp_set_default_file_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default file parameter. <a href="#ga64"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga65">stp_set_default_file_parameter_n</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const char *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default file parameter. <a href="#ga65"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga66">stp_set_default_float_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, double value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default float parameter. <a href="#ga66"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga67">stp_set_default_int_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default integer parameter. <a href="#ga67"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga68">stp_set_default_dimension_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default dimension parameter. <a href="#ga68"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga69">stp_set_default_boolean_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default boolean parameter. <a href="#ga69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga70">stp_set_default_curve_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const <a class="el" href="group__curve.html#ga0">stp_curve_t</a> *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default curve parameter. <a href="#ga70"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga71">stp_set_default_array_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const <a class="el" href="group__array.html#ga0">stp_array_t</a> *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default array parameter. <a href="#ga71"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga72">stp_set_default_raw_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, const void *value, size_t bytes)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a default raw parameter. <a href="#ga72"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga73">stp_get_string_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string parameter. <a href="#ga73"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga74">stp_get_file_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a file parameter. <a href="#ga74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga75">stp_get_float_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float parameter. <a href="#ga75"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga76">stp_get_int_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an integer parameter. <a href="#ga76"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga77">stp_get_dimension_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a dimension parameter. <a href="#ga77"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga78">stp_get_boolean_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a boolean parameter. <a href="#ga78"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__curve.html#ga0">stp_curve_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga79">stp_get_curve_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a curve parameter. <a href="#ga79"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__array.html#ga0">stp_array_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga80">stp_get_array_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an array parameter. <a href="#ga80"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structstp__raw__t.html">stp_raw_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga81">stp_get_raw_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a raw parameter. <a href="#ga81"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga82">stp_clear_string_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear a string parameter. <a href="#ga82"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga83">stp_clear_file_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear a file parameter. <a href="#ga83"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga84">stp_clear_float_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear (remove) a float parameter. <a href="#ga84"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga85">stp_clear_int_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear (remove) an integer parameter. <a href="#ga85"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga86">stp_clear_dimension_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear (remove) a dimension parameter. <a href="#ga86"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga87">stp_clear_boolean_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear (remove) a boolean parameter. <a href="#ga87"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga88">stp_clear_curve_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear a curve parameter. <a href="#ga88"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga89">stp_clear_array_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear an array parameter. <a href="#ga89"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga90">stp_clear_raw_parameter</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear a raw parameter. <a href="#ga90"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga91">stp_set_string_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a string parameter. <a href="#ga91"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga92">stp_set_file_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a file parameter. <a href="#ga92"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga93">stp_set_float_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a float parameter. <a href="#ga93"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga94">stp_set_int_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of an integer parameter. <a href="#ga94"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga95">stp_set_dimension_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a dimension parameter. <a href="#ga95"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga96">stp_set_boolean_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a boolean parameter. <a href="#ga96"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga97">stp_set_curve_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a curveparameter. <a href="#ga97"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga98">stp_set_array_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of an array parameter. <a href="#ga98"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga99">stp_set_raw_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the activity of a raw parameter. <a href="#ga99"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga100">stp_check_string_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a string parameter is set. <a href="#ga100"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga101">stp_check_file_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a file parameter is set. <a href="#ga101"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga102">stp_check_float_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a float parameter is set. <a href="#ga102"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga103">stp_check_int_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if an integer parameter is set. <a href="#ga103"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga104">stp_check_dimension_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a dimension parameter is set. <a href="#ga104"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga105">stp_check_boolean_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a boolean parameter is set. <a href="#ga105"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga106">stp_check_curve_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a curve parameter is set. <a href="#ga106"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga107">stp_check_array_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if an array parameter is set. <a href="#ga107"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga108">stp_check_raw_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a raw parameter is set. <a href="#ga108"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga109">stp_get_string_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a string parameter. <a href="#ga109"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga110">stp_get_file_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a file parameter. <a href="#ga110"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga111">stp_get_float_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a float parameter. <a href="#ga111"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga112">stp_get_int_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of an integer parameter. <a href="#ga112"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga113">stp_get_dimension_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a dimension parameter. <a href="#ga113"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga114">stp_get_boolean_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a boolean parameter. <a href="#ga114"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga115">stp_get_curve_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a curve parameter. <a href="#ga115"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga116">stp_get_array_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of an array parameter. <a href="#ga116"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga117">stp_get_raw_parameter_active</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the activity status of a raw parameter. <a href="#ga117"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga118">stp_get_media_size</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int *width, int *height)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the media (paper) size. <a href="#ga118"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga119">stp_get_imageable_area</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int *left, int *right, int *bottom, int *top)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the imagable area of the page. <a href="#ga119"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga120">stp_get_size_limit</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int *max_width, int *max_height, int *min_width, int *min_height)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the media size limits. <a href="#ga120"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga121">stp_describe_resolution</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int *x, int *y)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the printing resolution of the selected resolution. <a href="#ga121"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga122">stp_verify</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Verify parameters. <a href="#ga122"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga123">stp_default_settings</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get default global settings. <a href="#ga123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga124">stp_allocate_component_data</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *name, <a class="el" href="group__vars.html#ga4">stp_copy_data_func_t</a> copyfunc, <a class="el" href="group__vars.html#ga5">stp_free_data_func_t</a> freefunc, void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga125">stp_destroy_component_data</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga126">stp_get_component_data</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#ga136">stp_parameter_verify_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga127">stp_verify_parameter</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, const char *parameter, int quiet)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga128">stp_get_verified</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga129">stp_set_verified</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int value)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga130">stp_copy_options</a> (<a class="el" href="group__vars.html#ga0">stp_vars_t</a> *vd, const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *vs)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vars.html#ga131">stp_fill_parameter_settings</a> (<a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *desc, const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> *param)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The vars data type contains all the information about a print job, this includes information such as the printer model, paper size, print resolution etc. +<p> +Most of these job options are expressed as parameters which vary according to the model and other options selected.<p> +The representation of printer settings has changed dramatically from 4.2. All (well most, anyway) settings outside of basics such as the printer model and sizing settings are now typed parameters.<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="ga6"></a><!-- doxytag: member="vars.h::compdata_t" ref="ga6" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef struct stp_compdata <a class="el" href="group__vars.html#ga6">compdata_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga2"></a><!-- doxytag: member="vars.h::stp_const_parameter_list_t" ref="ga2" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef const void* <a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +The constant parameter_list opaque data type. +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga4"></a><!-- doxytag: member="vars.h::stp_copy_data_func_t" ref="ga4" args=")(void *)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef void*(* <a class="el" href="group__vars.html#ga4">stp_copy_data_func_t</a>)(void *) </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga5"></a><!-- doxytag: member="vars.h::stp_free_data_func_t" ref="ga5" args=")(void *)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef void(* <a class="el" href="group__vars.html#ga5">stp_free_data_func_t</a>)(void *) </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga3"></a><!-- doxytag: member="vars.h::stp_outfunc_t" ref="ga3" args=")(void *data, const char *buffer, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef void(* <a class="el" href="group__vars.html#ga3">stp_outfunc_t</a>)(void *data, const char *buffer, size_t bytes) </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Output function supplied by the calling application. +<p> +There are two output functions supplied by the caller, one to send output data and one to report errors. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>a pointer to an opaque object owned by the calling application. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>the data to output. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the size of buffer (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga1"></a><!-- doxytag: member="vars.h::stp_parameter_list_t" ref="ga1" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef void* <a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +The parameter_list opaque data type. +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga0"></a><!-- doxytag: member="vars.h::stp_vars_t" ref="ga0" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef struct stp_vars <a class="el" href="group__vars.html#ga0">stp_vars_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +The vars opaque data type. +<p> + </td> + </tr> +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="ga135"></a><!-- doxytag: member="vars.h::stp_parameter_activity_t" ref="ga135" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Parameter activity. +<p> +Whether a parameter is currently active (i. e. whether its value should be used by the driver or not). All parameters default to being active unless explicitly "turned off".<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga135a30"></a><!-- doxytag: member="STP_PARAMETER_INACTIVE" ref="gga135a30" args="" -->STP_PARAMETER_INACTIVE</em> </td><td> +Parameter is inactive (unused). </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga135a31"></a><!-- doxytag: member="STP_PARAMETER_DEFAULTED" ref="gga135a31" args="" -->STP_PARAMETER_DEFAULTED</em> </td><td> +Parameter is set to its default value. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga135a32"></a><!-- doxytag: member="STP_PARAMETER_ACTIVE" ref="gga135a32" args="" -->STP_PARAMETER_ACTIVE</em> </td><td> +Parameter is active (used). </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga133"></a><!-- doxytag: member="vars.h::stp_parameter_class_t" ref="ga133" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__vars.html#ga133">stp_parameter_class_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Parameter class. +<p> +What kind of setting this is, for the purpose of user interface representation.<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga133a17"></a><!-- doxytag: member="STP_PARAMETER_CLASS_FEATURE" ref="gga133a17" args="" -->STP_PARAMETER_CLASS_FEATURE</em> </td><td> +Printer feature. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga133a18"></a><!-- doxytag: member="STP_PARAMETER_CLASS_OUTPUT" ref="gga133a18" args="" -->STP_PARAMETER_CLASS_OUTPUT</em> </td><td> +Output control. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga133a19"></a><!-- doxytag: member="STP_PARAMETER_CLASS_CORE" ref="gga133a19" args="" -->STP_PARAMETER_CLASS_CORE</em> </td><td> +Core Gimp-Print parameter. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga133a20"></a><!-- doxytag: member="STP_PARAMETER_CLASS_INVALID" ref="gga133a20" args="" -->STP_PARAMETER_CLASS_INVALID</em> </td><td> +Invalid class (should never be used). </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga134"></a><!-- doxytag: member="vars.h::stp_parameter_level_t" ref="ga134" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__vars.html#ga134">stp_parameter_level_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Parameter level. +<p> +What "level" a setting is at, for UI design.<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga134a21"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_BASIC" ref="gga134a21" args="" -->STP_PARAMETER_LEVEL_BASIC</em> </td><td> +Basic parameter, shown by all UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a22"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_ADVANCED" ref="gga134a22" args="" -->STP_PARAMETER_LEVEL_ADVANCED</em> </td><td> +Advanced parameter, shown by advanced UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a23"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_ADVANCED1" ref="gga134a23" args="" -->STP_PARAMETER_LEVEL_ADVANCED1</em> </td><td> +Advanced1 parameter, shown by advanced UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a24"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_ADVANCED2" ref="gga134a24" args="" -->STP_PARAMETER_LEVEL_ADVANCED2</em> </td><td> +Advanced2 parameter, shown by advanced UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a25"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_ADVANCED3" ref="gga134a25" args="" -->STP_PARAMETER_LEVEL_ADVANCED3</em> </td><td> +Advanced3 parameter, shown by advanced UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a26"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_ADVANCED4" ref="gga134a26" args="" -->STP_PARAMETER_LEVEL_ADVANCED4</em> </td><td> +Advanced4 parameter, shown by advanced UIs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a27"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_INTERNAL" ref="gga134a27" args="" -->STP_PARAMETER_LEVEL_INTERNAL</em> </td><td> +Parameters used only within Gimp-Print. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a28"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_EXTERNAL" ref="gga134a28" args="" -->STP_PARAMETER_LEVEL_EXTERNAL</em> </td><td> +Parameters used only outside Gimp-Print. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga134a29"></a><!-- doxytag: member="STP_PARAMETER_LEVEL_INVALID" ref="gga134a29" args="" -->STP_PARAMETER_LEVEL_INVALID</em> </td><td> +Invalid level (should never be used). </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga132"></a><!-- doxytag: member="vars.h::stp_parameter_type_t" ref="ga132" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__vars.html#ga132">stp_parameter_type_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Parameter types. +<p> +The following types are permitted for a printer setting. Not all are currently implemented.<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga132a7"></a><!-- doxytag: member="STP_PARAMETER_TYPE_STRING_LIST" ref="gga132a7" args="" -->STP_PARAMETER_TYPE_STRING_LIST</em> </td><td> +Single string choice from a list. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a8"></a><!-- doxytag: member="STP_PARAMETER_TYPE_INT" ref="gga132a8" args="" -->STP_PARAMETER_TYPE_INT</em> </td><td> +Integer. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a9"></a><!-- doxytag: member="STP_PARAMETER_TYPE_BOOLEAN" ref="gga132a9" args="" -->STP_PARAMETER_TYPE_BOOLEAN</em> </td><td> +Boolean. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a10"></a><!-- doxytag: member="STP_PARAMETER_TYPE_DOUBLE" ref="gga132a10" args="" -->STP_PARAMETER_TYPE_DOUBLE</em> </td><td> +Floating point number. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a11"></a><!-- doxytag: member="STP_PARAMETER_TYPE_CURVE" ref="gga132a11" args="" -->STP_PARAMETER_TYPE_CURVE</em> </td><td> +Curve. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a12"></a><!-- doxytag: member="STP_PARAMETER_TYPE_FILE" ref="gga132a12" args="" -->STP_PARAMETER_TYPE_FILE</em> </td><td> +Filename (NYI, need to consider security). </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a13"></a><!-- doxytag: member="STP_PARAMETER_TYPE_RAW" ref="gga132a13" args="" -->STP_PARAMETER_TYPE_RAW</em> </td><td> +Raw, opaque data. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a14"></a><!-- doxytag: member="STP_PARAMETER_TYPE_ARRAY" ref="gga132a14" args="" -->STP_PARAMETER_TYPE_ARRAY</em> </td><td> +Array. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a15"></a><!-- doxytag: member="STP_PARAMETER_TYPE_DIMENSION" ref="gga132a15" args="" -->STP_PARAMETER_TYPE_DIMENSION</em> </td><td> +Linear dimension. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga132a16"></a><!-- doxytag: member="STP_PARAMETER_TYPE_INVALID" ref="gga132a16" args="" -->STP_PARAMETER_TYPE_INVALID</em> </td><td> +Invalid type (should never be used). </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga136"></a><!-- doxytag: member="vars.h::stp_parameter_verify_t" ref="ga136" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__vars.html#ga136">stp_parameter_verify_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga136a33"></a><!-- doxytag: member="PARAMETER_BAD" ref="gga136a33" args="" -->PARAMETER_BAD</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga136a34"></a><!-- doxytag: member="PARAMETER_OK" ref="gga136a34" args="" -->PARAMETER_OK</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga136a35"></a><!-- doxytag: member="PARAMETER_INACTIVE" ref="gga136a35" args="" -->PARAMETER_INACTIVE</em> </td><td> +</td></tr> +</table> +</dl> + </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="ga124"></a><!-- doxytag: member="vars.h::stp_allocate_component_data" ref="ga124" args="(stp_vars_t *v, const char *name, stp_copy_data_func_t copyfunc, stp_free_data_func_t freefunc, void *data)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_allocate_component_data </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga4">stp_copy_data_func_t</a> </td> + <td class="mdname" nowrap> <em>copyfunc</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga5">stp_free_data_func_t</a> </td> + <td class="mdname" nowrap> <em>freefunc</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>data</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga107"></a><!-- doxytag: member="vars.h::stp_check_array_parameter" ref="ga107" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_array_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if an array parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga105"></a><!-- doxytag: member="vars.h::stp_check_boolean_parameter" ref="ga105" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_boolean_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a boolean parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga106"></a><!-- doxytag: member="vars.h::stp_check_curve_parameter" ref="ga106" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_curve_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a curve parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga104"></a><!-- doxytag: member="vars.h::stp_check_dimension_parameter" ref="ga104" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_dimension_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a dimension parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga101"></a><!-- doxytag: member="vars.h::stp_check_file_parameter" ref="ga101" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_file_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a file parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga102"></a><!-- doxytag: member="vars.h::stp_check_float_parameter" ref="ga102" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a float parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga103"></a><!-- doxytag: member="vars.h::stp_check_int_parameter" ref="ga103" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_int_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if an integer parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga108"></a><!-- doxytag: member="vars.h::stp_check_raw_parameter" ref="ga108" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_raw_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a raw parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga100"></a><!-- doxytag: member="vars.h::stp_check_string_parameter" ref="ga100" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_check_string_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Check if a string parameter is set. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the minimum activity status.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga89"></a><!-- doxytag: member="vars.h::stp_clear_array_parameter" ref="ga89" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_array_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear an array parameter. +<p> +The parameter is set to NULL. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga87"></a><!-- doxytag: member="vars.h::stp_clear_boolean_parameter" ref="ga87" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_boolean_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear (remove) a boolean parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga88"></a><!-- doxytag: member="vars.h::stp_clear_curve_parameter" ref="ga88" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_curve_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear a curve parameter. +<p> +The parameter is set to NULL. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga86"></a><!-- doxytag: member="vars.h::stp_clear_dimension_parameter" ref="ga86" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_dimension_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear (remove) a dimension parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga83"></a><!-- doxytag: member="vars.h::stp_clear_file_parameter" ref="ga83" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_file_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear a file parameter. +<p> +The parameter is set to NULL. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga84"></a><!-- doxytag: member="vars.h::stp_clear_float_parameter" ref="ga84" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear (remove) a float parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga85"></a><!-- doxytag: member="vars.h::stp_clear_int_parameter" ref="ga85" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_int_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear (remove) an integer parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga90"></a><!-- doxytag: member="vars.h::stp_clear_raw_parameter" ref="ga90" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_raw_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear a raw parameter. +<p> +The parameter is set to NULL. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga82"></a><!-- doxytag: member="vars.h::stp_clear_string_parameter" ref="ga82" args="(stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_clear_string_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Clear a string parameter. +<p> +The parameter is set to NULL. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga130"></a><!-- doxytag: member="vars.h::stp_copy_options" ref="ga130" args="(stp_vars_t *vd, const stp_vars_t *vs)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_copy_options </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>vd</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>vs</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga123"></a><!-- doxytag: member="vars.h::stp_default_settings" ref="ga123" args="(void)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a>* stp_default_settings </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get default global settings. +<p> +The main use of this is to provide a usable stp_vars_t for purposes of parameter inquiry in the absence of a specific printer. This is currently used in a variety of places to get information on the standard color parameters without querying a particular printer. <dl compact><dt><b>Returns:</b></dt><dd>the default settings.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga47"></a><!-- doxytag: member="vars.h::stp_describe_parameter" ref="ga47" args="(const stp_vars_t *v, const char *name, stp_parameter_t *description)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_describe_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td> + <td class="mdname" nowrap> <em>description</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Describe a parameter in detail. +<p> +All of the parameter fields will be populated. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>a pointer to an <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> to store the parameter description in.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga121"></a><!-- doxytag: member="vars.h::stp_describe_resolution" ref="ga121" args="(const stp_vars_t *v, int *x, int *y)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_describe_resolution </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>x</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>y</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Retrieve the printing resolution of the selected resolution. +<p> +If the resolution is invalid, -1 will be returned in both x and y. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>a pointer to a int to store the horizontal resolution in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>a pointer to a int to store the vertical resolution in.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga125"></a><!-- doxytag: member="vars.h::stp_destroy_component_data" ref="ga125" args="(stp_vars_t *v, const char *name)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_destroy_component_data </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga131"></a><!-- doxytag: member="vars.h::stp_fill_parameter_settings" ref="ga131" args="(stp_parameter_t *desc, const stp_parameter_t *param)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_fill_parameter_settings </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td> + <td class="mdname" nowrap> <em>desc</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td> + <td class="mdname" nowrap> <em>param</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga80"></a><!-- doxytag: member="vars.h::stp_get_array_parameter" ref="ga80" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="group__array.html#ga0">stp_array_t</a>* stp_get_array_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get an array parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the array, or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga116"></a><!-- doxytag: member="vars.h::stp_get_array_parameter_active" ref="ga116" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_array_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of an array parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga78"></a><!-- doxytag: member="vars.h::stp_get_boolean_parameter" ref="ga78" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_boolean_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a boolean parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the boolean value.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga114"></a><!-- doxytag: member="vars.h::stp_get_boolean_parameter_active" ref="ga114" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_boolean_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a boolean parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga16"></a><!-- doxytag: member="vars.h::stp_get_color_conversion" ref="ga16" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const char* stp_get_color_conversion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the name of the color conversion routine. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the name of the color conversion routine (must not be freed).</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga126"></a><!-- doxytag: member="vars.h::stp_get_component_data" ref="ga126" args="(const stp_vars_t *v, const char *name)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* stp_get_component_data </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga79"></a><!-- doxytag: member="vars.h::stp_get_curve_parameter" ref="ga79" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="group__curve.html#ga0">stp_curve_t</a>* stp_get_curve_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a curve parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the curve, or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga115"></a><!-- doxytag: member="vars.h::stp_get_curve_parameter_active" ref="ga115" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_curve_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a curve parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga77"></a><!-- doxytag: member="vars.h::stp_get_dimension_parameter" ref="ga77" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_dimension_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a dimension parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the dimension (integer) value.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga113"></a><!-- doxytag: member="vars.h::stp_get_dimension_parameter_active" ref="ga113" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_dimension_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a dimension parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga13"></a><!-- doxytag: member="vars.h::stp_get_driver" ref="ga13" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const char* stp_get_driver </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the name of the printer driver. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the name of the printer driver (must not be freed).</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga36"></a><!-- doxytag: member="vars.h::stp_get_errdata" ref="ga36" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* stp_get_errdata </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the error data. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the output data.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga32"></a><!-- doxytag: member="vars.h::stp_get_errfunc" ref="ga32" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> stp_get_errfunc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the function used to print output information. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the outfunc.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga74"></a><!-- doxytag: member="vars.h::stp_get_file_parameter" ref="ga74" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const char* stp_get_file_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a file parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the filename, or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga110"></a><!-- doxytag: member="vars.h::stp_get_file_parameter_active" ref="ga110" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_file_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a file parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga75"></a><!-- doxytag: member="vars.h::stp_get_float_parameter" ref="ga75" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">double stp_get_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a float parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the float value.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga111"></a><!-- doxytag: member="vars.h::stp_get_float_parameter_active" ref="ga111" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_float_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a float parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga24"></a><!-- doxytag: member="vars.h::stp_get_height" ref="ga24" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_height </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the height of the image. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the left edge.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga119"></a><!-- doxytag: member="vars.h::stp_get_imageable_area" ref="ga119" args="(const stp_vars_t *v, int *left, int *right, int *bottom, int *top)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_get_imageable_area </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>left</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>right</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>bottom</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>top</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the imagable area of the page. +<p> +Retrieve the boundaries of the printable area of the page. In combination with the media size, this can be used to determine the actual printable region, which callers can use to place the image precisely. The dimensions are relative to the top left of the physical page.<p> +If a customizable page size is used (see stp_printer_get_media_size), the actual desired width and/or height must be filled in using stp_set_page_width and/or stp_set_page_height. If these are not filled in, the margins will be returned.<p> +Returned values may be negative if a printer is capable of full bleed by printing beyond the physical boundaries of the page.<p> +If the media size stored in V is invalid, the return values will be indeterminate. It is up to the user to specify legal values. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>left</em> </td><td>a pointer to a int to store the left edge in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>right</em> </td><td>a pointer to a int to store the right edge in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bottom</em> </td><td>a pointer to a int to store the bottom edge in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>top</em> </td><td>a pointer to a int to store the top edge in.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga76"></a><!-- doxytag: member="vars.h::stp_get_int_parameter" ref="ga76" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_int_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get an integer parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the integer value.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga112"></a><!-- doxytag: member="vars.h::stp_get_int_parameter_active" ref="ga112" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_int_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of an integer parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga18"></a><!-- doxytag: member="vars.h::stp_get_left" ref="ga18" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_left </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the left edge of the image. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the left edge.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga118"></a><!-- doxytag: member="vars.h::stp_get_media_size" ref="ga118" args="(const stp_vars_t *v, int *width, int *height)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_get_media_size </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>width</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>height</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the media (paper) size. +<p> +Retrieve the media size of the media type set in V, expressed in units of 1/72". If the media size is invalid, width and height will be set to -1. Values of 0 for width or height indicate that the dimension is variable, so that custom page sizes or roll paper can be used. In this case, the size limit should be used to determine maximum and minimum values permitted. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>a pointer to an int to store the media width in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>a pointer to an int to store the media height in.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga34"></a><!-- doxytag: member="vars.h::stp_get_outdata" ref="ga34" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* stp_get_outdata </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the output data. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the output data.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga30"></a><!-- doxytag: member="vars.h::stp_get_outfunc" ref="ga30" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> stp_get_outfunc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the function used to print output information. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the outfunc.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga28"></a><!-- doxytag: member="vars.h::stp_get_page_height" ref="ga28" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_page_height </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the page height. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the page height.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga26"></a><!-- doxytag: member="vars.h::stp_get_page_width" ref="ga26" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_page_width </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the page width. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the page width.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga38"></a><!-- doxytag: member="vars.h::stp_get_parameter_list" ref="ga38" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> stp_get_parameter_list </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +List the available parameters for the currently chosen settings. +<p> +This does not fill in the bounds and defaults; it merely provides a list of settings. To fill in detailed information for a setting, use stp_describe_parameter. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a list of available parameters (must be freed with <a class="el" href="group__vars.html#ga42">stp_parameter_list_destroy()</a>).</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga81"></a><!-- doxytag: member="vars.h::stp_get_raw_parameter" ref="ga81" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__raw__t.html">stp_raw_t</a>* stp_get_raw_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a raw parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the raw data, or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga117"></a><!-- doxytag: member="vars.h::stp_get_raw_parameter_active" ref="ga117" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_raw_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a raw parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga120"></a><!-- doxytag: member="vars.h::stp_get_size_limit" ref="ga120" args="(const stp_vars_t *v, int *max_width, int *max_height, int *min_width, int *min_height)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_get_size_limit </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>max_width</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>max_height</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>min_width</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>min_height</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the media size limits. +<p> +Retrieve the minimum and maximum size limits for custom media sizes with the current printer settings. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>max_width</em> </td><td>a pointer to a int to store the maximum width in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>max_height</em> </td><td>a pointer to a int to store the maximum height in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>min_width</em> </td><td>a pointer to a int to store the minimum width in. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>min_height</em> </td><td>a pointer to a int to store the minimum height in.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga73"></a><!-- doxytag: member="vars.h::stp_get_string_parameter" ref="ga73" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const char* stp_get_string_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a string parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the string, or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga109"></a><!-- doxytag: member="vars.h::stp_get_string_parameter_active" ref="ga109" args="(const stp_vars_t *v, const char *parameter)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> stp_get_string_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the activity status of a string parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the activity status.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga20"></a><!-- doxytag: member="vars.h::stp_get_top" ref="ga20" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_top </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the top edge of the image. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the left edge.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga128"></a><!-- doxytag: member="vars.h::stp_get_verified" ref="ga128" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_verified </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga22"></a><!-- doxytag: member="vars.h::stp_get_width" ref="ga22" args="(const stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_get_width </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the width edge of the image. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the left edge.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga37"></a><!-- doxytag: member="vars.h::stp_merge_printvars" ref="ga37" args="(stp_vars_t *user, const stp_vars_t *print)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_merge_printvars </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>user</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>print</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Merge defaults for a printer with user-chosen settings. +<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>This is likely to go away.</dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>the destination vars. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>print</em> </td><td>the vars to merge into user.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga48"></a><!-- doxytag: member="vars.h::stp_parameter_description_destroy" ref="ga48" args="(stp_parameter_t *description)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_parameter_description_destroy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>description</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Destroy a parameter description. +<p> +This must be called even if the <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> was not allocated with malloc, since some members are dynamically allocated. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>the parameter description to destroy.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga40"></a><!-- doxytag: member="vars.h::stp_parameter_find" ref="ga40" args="(stp_const_parameter_list_t list, const char *name)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a>* stp_parameter_find </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + <td class="mdname" nowrap> <em>list</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Find a parameter by its name. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the parameter_list to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the parameter (must not be freed), or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga49"></a><!-- doxytag: member="vars.h::stp_parameter_find_in_settings" ref="ga49" args="(const stp_vars_t *v, const char *name)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a>* stp_parameter_find_in_settings </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Find a parameter by its name from a vars object. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the parameter. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the parameter (must not be freed), or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga44"></a><!-- doxytag: member="vars.h::stp_parameter_list_add_param" ref="ga44" args="(stp_parameter_list_t list, const stp_parameter_t *item)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_parameter_list_add_param </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td> + <td class="mdname" nowrap> <em>list</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a> * </td> + <td class="mdname" nowrap> <em>item</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Add a parameter to a parameter_list. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the parameter_list to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>the parameter to add.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga46"></a><!-- doxytag: member="vars.h::stp_parameter_list_append" ref="ga46" args="(stp_parameter_list_t list, stp_const_parameter_list_t append)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_parameter_list_append </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td> + <td class="mdname" nowrap> <em>list</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + <td class="mdname" nowrap> <em>append</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Append one parameter_list to another. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the destination list (to append to). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>append</em> </td><td>the list of paramters to append. Each item that does not already exist in list will be appended.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga45"></a><!-- doxytag: member="vars.h::stp_parameter_list_copy" ref="ga45" args="(stp_const_parameter_list_t list)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> stp_parameter_list_copy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + <td class="mdname1" valign="top" nowrap> <em>list</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Copy and allocate a parameter_list. +<p> +A new parameter_list will be created, and then the contents of source will be copied into it. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the source parameter_list. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the new copy of the parameter_list.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga39"></a><!-- doxytag: member="vars.h::stp_parameter_list_count" ref="ga39" args="(stp_const_parameter_list_t list)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">size_t stp_parameter_list_count </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + <td class="mdname1" valign="top" nowrap> <em>list</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +List the number of available parameters for the currently chosen settings. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the parameter_list to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the number of parameters.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga43"></a><!-- doxytag: member="vars.h::stp_parameter_list_create" ref="ga43" args="(void)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> stp_parameter_list_create </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Create a parameter_list. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the newly created parameter_list.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga42"></a><!-- doxytag: member="vars.h::stp_parameter_list_destroy" ref="ga42" args="(stp_parameter_list_t list)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_parameter_list_destroy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga1">stp_parameter_list_t</a> </td> + <td class="mdname1" valign="top" nowrap> <em>list</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Destroy a parameter_list. +<p> +It is an error to destroy the parameter_list more than once. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the parameter_list to destroy.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga41"></a><!-- doxytag: member="vars.h::stp_parameter_list_param" ref="ga41" args="(stp_const_parameter_list_t list, size_t item)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__parameter__t.html">stp_parameter_t</a>* stp_parameter_list_param </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga2">stp_const_parameter_list_t</a> </td> + <td class="mdname" nowrap> <em>list</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>item</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Find a parameter by its index number. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the parameter_list to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>item</em> </td><td>the index number of the parameter (must not be greater than stp_parameter_list_count - 1). </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the parameter (must not be freed), or NULL if no parameter was found.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga61"></a><!-- doxytag: member="vars.h::stp_scale_float_parameter" ref="ga61" args="(stp_vars_t *v, const char *parameter, double scale)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_scale_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>double </td> + <td class="mdname" nowrap> <em>scale</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Multiply the value of a float parameter by a scaling factor. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>scale</em> </td><td>the factor to multiply the value by.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga59"></a><!-- doxytag: member="vars.h::stp_set_array_parameter" ref="ga59" args="(stp_vars_t *v, const char *parameter, const stp_array_t *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_array_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__array.html#ga0">stp_array_t</a> * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set an array parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga98"></a><!-- doxytag: member="vars.h::stp_set_array_parameter_active" ref="ga98" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_array_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of an array parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga57"></a><!-- doxytag: member="vars.h::stp_set_boolean_parameter" ref="ga57" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_boolean_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a boolean parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga96"></a><!-- doxytag: member="vars.h::stp_set_boolean_parameter_active" ref="ga96" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_boolean_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a boolean parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga14"></a><!-- doxytag: member="vars.h::stp_set_color_conversion" ref="ga14" args="(stp_vars_t *v, const char *val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_color_conversion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the name of the color conversion routine, if not the default. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the name to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga15"></a><!-- doxytag: member="vars.h::stp_set_color_conversion_n" ref="ga15" args="(stp_vars_t *v, const char *val, int bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_color_conversion_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>val</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the name of the color conversion routine, if not the default. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the name to set. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of val (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga58"></a><!-- doxytag: member="vars.h::stp_set_curve_parameter" ref="ga58" args="(stp_vars_t *v, const char *parameter, const stp_curve_t *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_curve_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__curve.html#ga0">stp_curve_t</a> * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a curve parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga97"></a><!-- doxytag: member="vars.h::stp_set_curve_parameter_active" ref="ga97" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_curve_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a curveparameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga71"></a><!-- doxytag: member="vars.h::stp_set_default_array_parameter" ref="ga71" args="(stp_vars_t *v, const char *parameter, const stp_array_t *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_array_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__array.html#ga0">stp_array_t</a> * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default array parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga69"></a><!-- doxytag: member="vars.h::stp_set_default_boolean_parameter" ref="ga69" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_boolean_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default boolean parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga70"></a><!-- doxytag: member="vars.h::stp_set_default_curve_parameter" ref="ga70" args="(stp_vars_t *v, const char *parameter, const stp_curve_t *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_curve_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__curve.html#ga0">stp_curve_t</a> * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default curve parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga68"></a><!-- doxytag: member="vars.h::stp_set_default_dimension_parameter" ref="ga68" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_dimension_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default dimension parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga64"></a><!-- doxytag: member="vars.h::stp_set_default_file_parameter" ref="ga64" args="(stp_vars_t *v, const char *parameter, const char *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_file_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default file parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga65"></a><!-- doxytag: member="vars.h::stp_set_default_file_parameter_n" ref="ga65" args="(stp_vars_t *v, const char *parameter, const char *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_file_parameter_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default file parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set (must not contain NUL). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga66"></a><!-- doxytag: member="vars.h::stp_set_default_float_parameter" ref="ga66" args="(stp_vars_t *v, const char *parameter, double value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>double </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default float parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga67"></a><!-- doxytag: member="vars.h::stp_set_default_int_parameter" ref="ga67" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_int_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default integer parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga72"></a><!-- doxytag: member="vars.h::stp_set_default_raw_parameter" ref="ga72" args="(stp_vars_t *v, const char *parameter, const void *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_raw_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const void * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default raw parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga62"></a><!-- doxytag: member="vars.h::stp_set_default_string_parameter" ref="ga62" args="(stp_vars_t *v, const char *parameter, const char *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_string_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default string parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga63"></a><!-- doxytag: member="vars.h::stp_set_default_string_parameter_n" ref="ga63" args="(stp_vars_t *v, const char *parameter, const char *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_default_string_parameter_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a default string parameter. +<p> +The value is set if the parameter is not already set. This avoids having to check if the parameter is set prior to setting it, if you do not want to override the existing value. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set (must not contain NUL). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga56"></a><!-- doxytag: member="vars.h::stp_set_dimension_parameter" ref="ga56" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_dimension_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a dimension parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga95"></a><!-- doxytag: member="vars.h::stp_set_dimension_parameter_active" ref="ga95" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_dimension_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a dimension parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga11"></a><!-- doxytag: member="vars.h::stp_set_driver" ref="ga11" args="(stp_vars_t *v, const char *val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_driver </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the name of the printer driver. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the name to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga12"></a><!-- doxytag: member="vars.h::stp_set_driver_n" ref="ga12" args="(stp_vars_t *v, const char *val, int bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_driver_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>val</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the name of the printer driver. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the name to set. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of val (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga35"></a><!-- doxytag: member="vars.h::stp_set_errdata" ref="ga35" args="(stp_vars_t *v, void *val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_errdata </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the error data. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the error data. This will typically be a file descriptor, but it is entirely up to the caller exactly what type this might be.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga31"></a><!-- doxytag: member="vars.h::stp_set_errfunc" ref="ga31" args="(stp_vars_t *v, stp_outfunc_t val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_errfunc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the function used to print error and diagnostic information. +<p> +These must be supplied by the caller. errdata is passed as an arguments to errfunc; typically it will be a file descriptor. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga52"></a><!-- doxytag: member="vars.h::stp_set_file_parameter" ref="ga52" args="(stp_vars_t *v, const char *parameter, const char *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_file_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a file parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga92"></a><!-- doxytag: member="vars.h::stp_set_file_parameter_active" ref="ga92" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_file_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a file parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga53"></a><!-- doxytag: member="vars.h::stp_set_file_parameter_n" ref="ga53" args="(stp_vars_t *v, const char *parameter, const char *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_file_parameter_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a file parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set (must not contain NUL). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga54"></a><!-- doxytag: member="vars.h::stp_set_float_parameter" ref="ga54" args="(stp_vars_t *v, const char *parameter, double value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_float_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>double </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a float parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga93"></a><!-- doxytag: member="vars.h::stp_set_float_parameter_active" ref="ga93" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_float_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a float parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga23"></a><!-- doxytag: member="vars.h::stp_set_height" ref="ga23" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_height </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the height of the image. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga55"></a><!-- doxytag: member="vars.h::stp_set_int_parameter" ref="ga55" args="(stp_vars_t *v, const char *parameter, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_int_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set an integer parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga94"></a><!-- doxytag: member="vars.h::stp_set_int_parameter_active" ref="ga94" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_int_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of an integer parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga17"></a><!-- doxytag: member="vars.h::stp_set_left" ref="ga17" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_left </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the left edge of the image. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga33"></a><!-- doxytag: member="vars.h::stp_set_outdata" ref="ga33" args="(stp_vars_t *v, void *val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_outdata </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the output data. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the output data. This will typically be a file descriptor, but it is entirely up to the caller exactly what type this might be.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga29"></a><!-- doxytag: member="vars.h::stp_set_outfunc" ref="ga29" args="(stp_vars_t *v, stp_outfunc_t val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_outfunc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga3">stp_outfunc_t</a> </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the function used to print output information. +<p> +These must be supplied by the caller. outdata is passed as an arguments to outfunc; typically it will be a file descriptor. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga27"></a><!-- doxytag: member="vars.h::stp_set_page_height" ref="ga27" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_page_height </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the page height. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga25"></a><!-- doxytag: member="vars.h::stp_set_page_width" ref="ga25" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_page_width </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the page width. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga60"></a><!-- doxytag: member="vars.h::stp_set_raw_parameter" ref="ga60" args="(stp_vars_t *v, const char *parameter, const void *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_raw_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const void * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a raw parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga99"></a><!-- doxytag: member="vars.h::stp_set_raw_parameter_active" ref="ga99" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_raw_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a raw parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga50"></a><!-- doxytag: member="vars.h::stp_set_string_parameter" ref="ga50" args="(stp_vars_t *v, const char *parameter, const char *value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_string_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a string parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga91"></a><!-- doxytag: member="vars.h::stp_set_string_parameter_active" ref="ga91" args="(const stp_vars_t *v, const char *parameter, stp_parameter_activity_t active)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_string_parameter_active </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="group__vars.html#ga135">stp_parameter_activity_t</a> </td> + <td class="mdname" nowrap> <em>active</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the activity of a string parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>the activity status to set (should be set to STP_PARAMETER_ACTIVE or STP_PARAMETER_INACTIVE).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga51"></a><!-- doxytag: member="vars.h::stp_set_string_parameter_n" ref="ga51" args="(stp_vars_t *v, const char *parameter, const char *value, size_t bytes)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_string_parameter_n </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>size_t </td> + <td class="mdname" nowrap> <em>bytes</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set a string parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>parameter</em> </td><td>the name of the parameter. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to set (must not contain NUL). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>the length of value (in bytes).</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga19"></a><!-- doxytag: member="vars.h::stp_set_top" ref="ga19" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_top </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the top edge of the image. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga129"></a><!-- doxytag: member="vars.h::stp_set_verified" ref="ga129" args="(stp_vars_t *v, int value)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_verified </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>value</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga21"></a><!-- doxytag: member="vars.h::stp_set_width" ref="ga21" args="(stp_vars_t *v, int val)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_set_width </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>val</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Set the width of the image. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>the value to set.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga8"></a><!-- doxytag: member="vars.h::stp_vars_copy" ref="ga8" args="(stp_vars_t *dest, const stp_vars_t *source)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_vars_copy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>dest</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>source</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Copy a vars object. +<p> +Both dest and source must be valid vars objects previously created with <a class="el" href="group__vars.html#ga7">stp_vars_create()</a>. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the destination vars. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source vars.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga7"></a><!-- doxytag: member="vars.h::stp_vars_create" ref="ga7" args="(void)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a>* stp_vars_create </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Create a new vars object. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the newly created vars object.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga9"></a><!-- doxytag: member="vars.h::stp_vars_create_copy" ref="ga9" args="(const stp_vars_t *source)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a>* stp_vars_create_copy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>source</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Copy and allocate a vars object. +<p> +source must be a valid vars object previously created with <a class="el" href="group__vars.html#ga7">stp_vars_create()</a>. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source vars. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the new copy of the vars.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga10"></a><!-- doxytag: member="vars.h::stp_vars_destroy" ref="ga10" args="(stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_vars_destroy </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Destroy a vars object. +<p> +It is an error to destroy the vars more than once. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to destroy.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a class="anchor" name="ga122"></a><!-- doxytag: member="vars.h::stp_verify" ref="ga122" args="(stp_vars_t *v)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_verify </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>v</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Verify parameters. +<p> +Verify that the parameters selected are consistent with those allowed by the driver. This must be called prior to printing; failure to do so will result in printing failing. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>the vars to use. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>0 on failure, 1 on success; other status values are reserved.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga127"></a><!-- doxytag: member="vars.h::stp_verify_parameter" ref="ga127" args="(const stp_vars_t *v, const char *parameter, int quiet)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="group__vars.html#ga136">stp_parameter_verify_t</a> stp_verify_parameter </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>quiet</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 2 09:45:10 2005 for libgutenprint API Reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.3-20050530 </small></address> +</body> +</html> |