diff options
author | msweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2008-04-17 00:50:22 +0000 |
---|---|---|
committer | msweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2008-04-17 00:50:22 +0000 |
commit | ae71f5deb42f3d526b5f35d2eed9241abb6405ba (patch) | |
tree | c7ecc0ccd7d71c36c78085af240d52c0a5e66a2d /doc | |
parent | 839a51c83c61febe8d4c9ba56f6a05fce3d03710 (diff) |
Import CUPS 1.4svn-r7464.
git-svn-id: svn+ssh://src.apple.com/svn/cups/easysw/current@713 a1ca3aef-8c08-0410-bb20-df032aa958be
Diffstat (limited to 'doc')
-rw-r--r-- | doc/help/api-cups.html | 106 | ||||
-rw-r--r-- | doc/help/api-httpipp.html | 133 | ||||
-rw-r--r-- | doc/help/spec-ipp.html | 11 |
3 files changed, 150 insertions, 100 deletions
diff --git a/doc/help/api-cups.html b/doc/help/api-cups.html index 654edaf27..b6eb2ab81 100644 --- a/doc/help/api-cups.html +++ b/doc/help/api-cups.html @@ -320,8 +320,6 @@ div.contents ul.subcontents li { <li><a href="#cupsGetDest" title="Get the named destination from the list.">cupsGetDest</a></li> <li><a href="#cupsGetDests" title="Get the list of destinations from the default server.">cupsGetDests</a></li> <li><a href="#cupsGetDests2" title="Get the list of destinations from the specified server.">cupsGetDests2</a></li> -<li><a href="#cupsGetFd" title="Get a file from the server.">cupsGetFd</a></li> -<li><a href="#cupsGetFile" title="Get a file from the server.">cupsGetFile</a></li> <li><a href="#cupsGetJobs" title="Get the jobs from the default server.">cupsGetJobs</a></li> <li><a href="#cupsGetJobs2" title="Get the jobs from the specified server.">cupsGetJobs2</a></li> <li><a href="#cupsGetNamedDest" title="Get options for the named destination.">cupsGetNamedDest</a></li> @@ -351,8 +349,6 @@ server.">cupsPrintFile2</a></li> default server.">cupsPrintFiles</a></li> <li><a href="#cupsPrintFiles2" title="Print one or more files to a printer or class on the specified server.">cupsPrintFiles2</a></li> -<li><a href="#cupsPutFd" title="Put a file on the server.">cupsPutFd</a></li> -<li><a href="#cupsPutFile" title="Put a file on the server.">cupsPutFile</a></li> <li><a href="#cupsRemoveDest" title="Remove a destination from the destination list.">cupsRemoveDest</a></li> <li><a href="#cupsRemoveOption" title="Remove an option from an option array.">cupsRemoveOption</a></li> <li><a href="#cupsServer" title="Return the hostname/address of the default server.">cupsServer</a></li> @@ -371,6 +367,7 @@ specified server.">cupsPrintFiles2</a></li> </ul> <li><a href="#TYPES">Data Types</a><ul class="code"> <li><a href="#cups_dest_t" title="Destination">cups_dest_t</a></li> + <li><a href="#cups_device_cb_t" title="Device callback ">cups_device_cb_t</a></li> <li><a href="#cups_job_t" title="Job">cups_job_t</a></li> <li><a href="#cups_option_t" title="Printer Options">cups_option_t</a></li> <li><a href="#cups_password_cb_t" title="Password callback">cups_password_cb_t</a></li> @@ -1171,52 +1168,6 @@ Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. </p> -<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsGetFd">cupsGetFd</a></h3> -<p class="description">Get a file from the server.</p> -<p class="code"> -http_status_t cupsGetFd (<br> - http_t *http,<br> - const char *resource,<br> - int fd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_OK</code> when the file is successfully retrieved. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsGetFile">cupsGetFile</a></h3> -<p class="description">Get a file from the server.</p> -<p class="code"> -http_status_t cupsGetFile (<br> - http_t *http,<br> - const char *resource,<br> - const char *filename<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>filename</dt> -<dd class="description">Filename</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_OK</code> when the file is successfully retrieved. - -</p> <h3 class="function"><a name="cupsGetJobs">cupsGetJobs</a></h3> <p class="description">Get the jobs from the default server.</p> <p class="code"> @@ -1719,54 +1670,6 @@ int cupsPrintFiles2 (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Job ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsPutFd">cupsPutFd</a></h3> -<p class="description">Put a file on the server.</p> -<p class="code"> -http_status_t cupsPutFd (<br> - http_t *http,<br> - const char *resource,<br> - int fd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored -successfully. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsPutFile">cupsPutFile</a></h3> -<p class="description">Put a file on the server.</p> -<p class="code"> -http_status_t cupsPutFile (<br> - http_t *http,<br> - const char *resource,<br> - const char *filename<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>filename</dt> -<dd class="description">Filename</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored -successfully. - -</p> <h3 class="function"><span class="info"> CUPS 1.3 </span><a name="cupsRemoveDest">cupsRemoveDest</a></h3> <p class="description">Remove a destination from the destination list.</p> <p class="code"> @@ -2049,6 +1952,11 @@ const char *cupsUser (void);</p> <p class="code"> typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; </p> +<h3 class="typedef"><span class="info"> CUPS 1.4 </span><a name="cups_device_cb_t">cups_device_cb_t</a></h3> +<p class="description">Device callback </p> +<p class="code"> +typedef void (*cups_device_cb_t)(const char *device_class, const char *device_id, const char *device_info, const char *device_make_and_model, const char *device_uri, void *user_data); +</p> <h3 class="typedef"><a name="cups_job_t">cups_job_t</a></h3> <p class="description">Job</p> <p class="code"> @@ -2062,7 +1970,7 @@ typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; <h3 class="typedef"><a name="cups_password_cb_t">cups_password_cb_t</a></h3> <p class="description">Password callback</p> <p class="code"> -typedef const char *(*cups_password_cb_t)(const char *); +typedef const char *(*cups_password_cb_t)(const char *prompt); </p> <h3 class="typedef"><a name="cups_ptype_t">cups_ptype_t</a></h3> <p class="description">Printer type/capability bits</p> diff --git a/doc/help/api-httpipp.html b/doc/help/api-httpipp.html index 04fc4a06b..045523702 100644 --- a/doc/help/api-httpipp.html +++ b/doc/help/api-httpipp.html @@ -304,7 +304,12 @@ div.contents ul.subcontents li { <li><a href="#cupsDoRequest" title="Do an IPP request.">cupsDoRequest</a></li> <li><a href="#cupsEncodeOptions" title="Encode printer options into IPP attributes.">cupsEncodeOptions</a></li> <li><a href="#cupsEncodeOptions2" title="Encode printer options into IPP attributes for a group.">cupsEncodeOptions2</a></li> +<li><a href="#cupsGetDevices" title="Get available printer devices.">cupsGetDevices</a></li> +<li><a href="#cupsGetFd" title="Get a file from the server.">cupsGetFd</a></li> +<li><a href="#cupsGetFile" title="Get a file from the server.">cupsGetFile</a></li> <li><a href="#cupsGetResponse" title="Get a response to an IPP request.">cupsGetResponse</a></li> +<li><a href="#cupsPutFd" title="Put a file on the server.">cupsPutFd</a></li> +<li><a href="#cupsPutFile" title="Put a file on the server.">cupsPutFile</a></li> <li><a href="#cupsReadResponseData" title="Read additional data after the IPP response.">cupsReadResponseData</a></li> <li><a href="#cupsSendRequest" title="Send an IPP request.">cupsSendRequest</a></li> <li><a href="#cupsWriteRequestData" title="Write additional data after an IPP request.">cupsWriteRequestData</a></li> @@ -955,6 +960,84 @@ function multiple times for each group, or use cupsEncodeOptions() to add the standard groups. </p> +<h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsGetDevices">cupsGetDevices</a></h3> +<p class="description">Get available printer devices.</p> +<p class="code"> +ipp_status_t cupsGetDevices (<br> + <a href="#http_t">http_t</a> *http,<br> + int timeout,<br> + const char *exclude_schemes,<br> + cups_device_cb_t callback,<br> + void *user_data<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> +<dt>timeout</dt> +<dd class="description">Timeout in seconds or <code>CUPS_TIMEOUT_DEFAULT</code></dd> +<dt>exclude_schemes</dt> +<dd class="description">Comma-separated URI schemes to exclude or <code>CUPS_EXCLUDE_NONE</code></dd> +<dt>callback</dt> +<dd class="description">Callback function</dd> +<dt>user_data</dt> +<dd class="description">User data pointer</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Request status - <code>IPP_OK</code> on success.</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">This function sends a CUPS-Get-Devices request and streams the discovered +devices to the specified callback function. The "timeout" parameter controls +how long the request lasts, while the "exclude_schemes" parameter provides +a comma-delimited list of backends to omit from the request. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsGetFd">cupsGetFd</a></h3> +<p class="description">Get a file from the server.</p> +<p class="code"> +http_status_t cupsGetFd (<br> + <a href="#http_t">http_t</a> *http,<br> + const char *resource,<br> + int fd<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> +<dt>resource</dt> +<dd class="description">Resource name</dd> +<dt>fd</dt> +<dd class="description">File descriptor</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">HTTP status</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">This function returns <code>HTTP_OK</code> when the file is successfully retrieved. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsGetFile">cupsGetFile</a></h3> +<p class="description">Get a file from the server.</p> +<p class="code"> +http_status_t cupsGetFile (<br> + <a href="#http_t">http_t</a> *http,<br> + const char *resource,<br> + const char *filename<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> +<dt>resource</dt> +<dd class="description">Resource name</dd> +<dt>filename</dt> +<dd class="description">Filename</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">HTTP status</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">This function returns <code>HTTP_OK</code> when the file is successfully retrieved. + +</p> <h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsGetResponse">cupsGetResponse</a></h3> <p class="description">Get a response to an IPP request.</p> <p class="code"> @@ -977,6 +1060,54 @@ cupsSendDocument() or cupsSendRequest(). For requests that return additional data, use httpRead() after getting a successful response. </p> +<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsPutFd">cupsPutFd</a></h3> +<p class="description">Put a file on the server.</p> +<p class="code"> +http_status_t cupsPutFd (<br> + <a href="#http_t">http_t</a> *http,<br> + const char *resource,<br> + int fd<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> +<dt>resource</dt> +<dd class="description">Resource name</dd> +<dt>fd</dt> +<dd class="description">File descriptor</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">HTTP status</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored +successfully. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsPutFile">cupsPutFile</a></h3> +<p class="description">Put a file on the server.</p> +<p class="code"> +http_status_t cupsPutFile (<br> + <a href="#http_t">http_t</a> *http,<br> + const char *resource,<br> + const char *filename<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> +<dt>resource</dt> +<dd class="description">Resource name</dd> +<dt>filename</dt> +<dd class="description">Filename</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">HTTP status</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored +successfully. + +</p> <h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsReadResponseData">cupsReadResponseData</a></h3> <p class="description">Read additional data after the IPP response.</p> <p class="code"> @@ -1019,7 +1150,7 @@ http_status_t cupsSendRequest (<br> <dt>resource</dt> <dd class="description">Resource path</dd> <dt>length</dt> -<dd class="description">Length of data to follow or CUPS_LENGTH_VARIABLE</dd> +<dd class="description">Length of data to follow or <code>CUPS_LENGTH_VARIABLE</code></dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Initial HTTP status</p> diff --git a/doc/help/spec-ipp.html b/doc/help/spec-ipp.html index 0d768c9fb..e5d0f3762 100644 --- a/doc/help/spec-ipp.html +++ b/doc/help/spec-ipp.html @@ -1571,6 +1571,12 @@ CUPS-Get-Devices request: <dd>The client OPTIONALLY supplies a device class keyword to select which devices are returned. + <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span> + + <dd>The client OPTIONALLY supplies a set of scheme names that the + requestor does not want to discover. If the client omits this attribute, + the server responds with devices of all schemes. + <dt>"limit" (integer (1:MAX)): <dd>The client OPTIONALLY supplies this attribute limiting the number of @@ -1583,6 +1589,11 @@ CUPS-Get-Devices request: the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'. + <dt>"timeout" (integer (1:MAX)) :<span class='info'>CUPS 1.4</span> + + <dd>The client OPTIONALLY supplies this attribute limiting the number of + devices that are returned. + </dl> <h4>CUPS-Get-Devices Response</h4> |