-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- SECTION: Programming -->
<head>
-<title>HTTP and IPP APIs</title>
-<meta name="keywords" content="Programming">
-<meta name="creator" content="Mini-XML v2.5">
+ <title>HTTP and IPP APIs </title>
+ <meta name="keywords" content="Programming">
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <meta name="creator" content="Mini-XML v2.7">
<style type="text/css"><!--
BODY {
font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}
PRE.command {
+ border: dotted thin #7f7f7f;
margin-left: 36pt;
+ padding: 10px;
}
+P.compact {
+ margin: 0;
+}
+
+P.example {
+ font-style: italic;
+ margin-left: 36pt;
+}
+
PRE.example {
background: #eeeeee;
border: dotted thin #999999;
margin-left: 36pt;
- padding: 10px;
+ padding: 10pt;
}
PRE.command EM, PRE.example EM {
}
BLOCKQUOTE {
- background: #cccccc;
+ background: #eeeeee;
border: solid thin #999999;
padding: 10pt;
}
+A IMG {
+ border: none;
+}
+
+A:link:hover IMG {
+ background: #f0f0f0;
+ border-radius: 10px;
+ -moz-border-radius: 10px;
+}
+
A:link, A:visited {
+ font-weight: normal;
text-decoration: none;
- font-weight: bold;
}
A:link:hover, A:visited:hover, A:active {
text-decoration: underline;
- font-weight: bold;
}
SUB, SUP {
font-size: 50%;
}
+TR.data, TD.data, TR.data TD {
+ margin-top: 10pt;
+ padding: 5pt;
+ border-bottom: solid 1pt #999999;
+}
+
+TR.data TH {
+ border-bottom: solid 1pt #999999;
+ padding-top: 10pt;
+ padding-left: 5pt;
+ text-align: left;
+}
+
DIV.table TABLE {
border: solid thin #999999;
border-collapse: collapse;
}
TH.label {
- padding-top: 5pt;
text-align: right;
vertical-align: top;
}
+TH.sublabel {
+ text-align: right;
+ font-weight: normal;
+}
+
HR {
border: solid thin;
}
SPAN.info {
- background: #000000;
- border: thin solid #000000;
- color: #ffffff;
+ background: black;
+ border: thin solid black;
+ color: white;
font-size: 80%;
font-style: italic;
font-weight: bold;
font-size: 100%;
}
+H1.title {
+}
+
H2.title, H3.title {
border-bottom: solid 2pt #000000;
}
+DIV.indent, TABLE.indent {
+ margin-top: 2em;
+ margin-left: auto;
+ margin-right: auto;
+ width: 90%;
+}
+
+TABLE.indent {
+ border-collapse: collapse;
+}
+
+TABLE.indent TD, TABLE.indent TH {
+ padding: 0;
+}
+
+TABLE.list {
+ border-collapse: collapse;
+ margin-left: auto;
+ margin-right: auto;
+ width: 90%;
+}
+
+TABLE.list TH {
+ background: white;
+ border-bottom: solid thin #cccccc;
+ color: #444444;
+ padding-top: 10pt;
+ padding-left: 5pt;
+ text-align: left;
+ vertical-align: bottom;
+ white-space: nowrap;
+}
+
+TABLE.list TH A {
+ color: #4444cc;
+}
+
+TABLE.list TD {
+ border-bottom: solid thin #eeeeee;
+ padding-top: 5pt;
+ padding-left: 5pt;
+}
+
+TABLE.list TR:nth-child(even) {
+ background: #f8f8f8;
+}
+
+TABLE.list TR:nth-child(odd) {
+ background: #f4f4f4;
+}
+
DT {
margin-left: 36pt;
margin-top: 12pt;
font-family: monaco, courier, monospace;
}
-SPAN.message {
- font-style: italic;
- font-size: smaller;
-}
-
DIV.summary TABLE {
border: solid thin #999999;
border-collapse: collapse;
div.contents ul.contents {
font-size: 80%;
}
+div.contents ul.subcontents li {
+ margin-left: 1em;
+ text-indent: -1em;
+}
--></style>
</head>
<body>
<div class='body'>
<!--
- "$Id: api-httpipp.header 7258 2008-01-28 00:15:05Z mike $"
+ "$Id$"
HTTP and IPP API header for the Common UNIX Printing System (CUPS).
- Copyright 2007-2008 by Apple Inc.
+ Copyright 2007-2009 by Apple Inc.
Copyright 1997-2006 by Easy Software Products, all rights reserved.
These coded instructions, statements, and computer programs are the
file is missing or damaged, see the license at "http://www.cups.org/".
-->
-<h1 class="title">HTTP and IPP APIs</h1>
+<h1 class='title'>HTTP and IPP APIs</h1>
<div class='summary'><table summary='General Information'>
<thead>
</table></div>
<h2 class="title">Contents</h2>
<ul class="contents">
-</li>
<li><a href="#OVERVIEW">Overview</a><ul class="subcontents">
-<li><a href="#CREATING_URI_STRINGS">Creating URI Strings</a></li>
-<li><a href="#SENDING_REQUESTS_WITH_FILES">Sending Requests with Files</a></li>
-<li><a href="#ASYNCHRONOUS_REQUEST_PROCESSING">Asynchronous Request Processing</a></li>
+
<li><a href="#CREATING_URI_STRINGS">Creating URI Strings</a></li>
+
<li><a href="#SENDING_REQUESTS_WITH_FILES">Sending Requests with Files</a></li>
+
<li><a href="#ASYNCHRONOUS_REQUEST_PROCESSING">Asynchronous Request Processing</a></li>
</ul></li>
<li><a href="#FUNCTIONS">Functions</a><ul class="code">
-<li><a href="#cupsDoAuthentication" title="Authenticate a request.">cupsDoAuthentication</a></li>
-<li><a href="#cupsDoFileRequest" title="Do an IPP request with a file.">cupsDoFileRequest</a></li>
-<li><a href="#cupsDoIORequest" title="Do an IPP request with file descriptors.">cupsDoIORequest</a></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="#cupsGetResponse" title="Get a response to an IPP request.">cupsGetResponse</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>
-<li><a href="#httpAddrAny" title="Check for the "any" address.">httpAddrAny</a></li>
-<li><a href="#httpAddrEqual" title="Compare two addresses.">httpAddrEqual</a></li>
-<li><a href="#httpAddrLength" title="Return the length of the address in bytes.">httpAddrLength</a></li>
-<li><a href="#httpAddrLocalhost" title="Check for the local loopback address.">httpAddrLocalhost</a></li>
-<li><a href="#httpAddrLookup" title="Lookup the hostname associated with the address.">httpAddrLookup</a></li>
-<li><a href="#httpAddrString" title="Convert an address to a numeric string.">httpAddrString</a></li>
-<li><a href="#httpAssembleURI" title="Assemble a uniform resource identifier from its
+ <li><a href="#cupsDoAuthentication" title="Authenticate a request.">cupsDoAuthentication</a></li>
+ <li><a href="#cupsDoFileRequest" title="Do an IPP request with a file.">cupsDoFileRequest</a></li>
+ <li><a href="#cupsDoIORequest" title="Do an IPP request with file descriptors.">cupsDoIORequest</a></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="#cupsLastError" title="Return the last IPP status code.">cupsLastError</a></li>
+ <li><a href="#cupsLastErrorString" title="Return the last IPP status-message.">cupsLastErrorString</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>
+ <li><a href="#httpAddCredential" title="Allocates and adds a single credential to an array.">httpAddCredential</a></li>
+ <li><a href="#httpAddrAny" title="Check for the "any" address.">httpAddrAny</a></li>
+ <li><a href="#httpAddrEqual" title="Compare two addresses.">httpAddrEqual</a></li>
+ <li><a href="#httpAddrLength" title="Return the length of the address in bytes.">httpAddrLength</a></li>
+ <li><a href="#httpAddrLocalhost" title="Check for the local loopback address.">httpAddrLocalhost</a></li>
+ <li><a href="#httpAddrLookup" title="Lookup the hostname associated with the address.">httpAddrLookup</a></li>
+ <li><a href="#httpAddrString" title="Convert an address to a numeric string.">httpAddrString</a></li>
+ <li><a href="#httpAssembleURI" title="Assemble a uniform resource identifier from its
components.">httpAssembleURI</a></li>
-<li><a href="#httpAssembleURIf" title="Assemble a uniform resource identifier from its
+
<li><a href="#httpAssembleURIf" title="Assemble a uniform resource identifier from its
components with a formatted resource.">httpAssembleURIf</a></li>
-<li><a href="#httpBlocking" title="Set blocking/non-blocking behavior on a connection.">httpBlocking</a></li>
-<li><a href="#httpCheck" title="Check to see if there is a pending response from the server.">httpCheck</a></li>
-<li><a href="#httpClearCookie" title="Clear the cookie value(s).">httpClearCookie</a></li>
-<li><a href="#httpClearFields" title="Clear HTTP request fields.">httpClearFields</a></li>
-<li><a href="#httpClose" title="Close an HTTP connection...">httpClose</a></li>
-<li><a href="#httpConnect" title="Connect to a HTTP server.">httpConnect</a></li>
-<li><a href="#httpConnectEncrypt" title="Connect to a HTTP server using encryption.">httpConnectEncrypt</a></li>
-<li><a href="#httpDecode64" title="Base64-decode a string.">httpDecode64</a></li>
-<li><a href="#httpDecode64_2" title="Base64-decode a string.">httpDecode64_2</a></li>
-<li><a href="#httpDelete" title="Send a DELETE request to the server.">httpDelete</a></li>
-<li><a href="#httpEncode64" title="Base64-encode a string.">httpEncode64</a></li>
-<li><a href="#httpEncode64_2" title="Base64-encode a string.">httpEncode64_2</a></li>
-<li><a href="#httpEncryption" title="Set the required encryption on the link.">httpEncryption</a></li>
-<li><a href="#httpError" title="Get the last error on a connection.">httpError</a></li>
-<li><a href="#httpFlush" title="Flush data from a HTTP connection.">httpFlush</a></li>
-<li><a href="#httpFlushWrite" title="Flush data in write buffer.">httpFlushWrite</a></li>
-<li><a href="#httpGet" title="Send a GET request to the server.">httpGet</a></li>
-<li><a href="#httpGetAuthString" title="Get the current authorization string.">httpGetAuthString</a></li>
-<li><a href="#httpGetBlocking" title="Get the blocking/non-block state of a connection.">httpGetBlocking</a></li>
-<li><a href="#httpGetCookie" title="Get any cookie data from the response.">httpGetCookie</a></li>
-<li><a href="#httpGetDateString" title="Get a formatted date/time string from a time value.">httpGetDateString</a></li>
-<li><a href="#httpGetDateString2" title="Get a formatted date/time string from a time value.">httpGetDateString2</a></li>
-<li><a href="#httpGetDateTime" title="Get a time value from a formatted date/time string.">httpGetDateTime</a></li>
-<li><a href="#httpGetFd" title="Get the file descriptor associated with a connection.">httpGetFd</a></li>
-<li><a href="#httpGetField" title="Get a field value from a request/response.">httpGetField</a></li>
-<li><a href="#httpGetHostByName" title="Lookup a hostname or IPv4 address, and return
+ <li><a href="#httpBlocking" title="Set blocking/non-blocking behavior on a connection.">httpBlocking</a></li>
+ <li><a href="#httpCheck" title="Check to see if there is a pending response from the server.">httpCheck</a></li>
+ <li><a href="#httpClearCookie" title="Clear the cookie value(s).">httpClearCookie</a></li>
+ <li><a href="#httpClearFields" title="Clear HTTP request fields.">httpClearFields</a></li>
+ <li><a href="#httpClose" title="Close an HTTP connection.">httpClose</a></li>
+ <li><a href="#httpConnect" title="Connect to a HTTP server.">httpConnect</a></li>
+ <li><a href="#httpConnectEncrypt" title="Connect to a HTTP server using encryption.">httpConnectEncrypt</a></li>
+ <li><a href="#httpCopyCredentials" title="Copy the credentials associated with an encrypted
+connection.">httpCopyCredentials</a></li>
+ <li><a href="#httpDecode64" title="Base64-decode a string.">httpDecode64</a></li>
+ <li><a href="#httpDecode64_2" title="Base64-decode a string.">httpDecode64_2</a></li>
+ <li><a href="#httpDelete" title="Send a DELETE request to the server.">httpDelete</a></li>
+ <li><a href="#httpEncode64" title="Base64-encode a string.">httpEncode64</a></li>
+ <li><a href="#httpEncode64_2" title="Base64-encode a string.">httpEncode64_2</a></li>
+ <li><a href="#httpEncryption" title="Set the required encryption on the link.">httpEncryption</a></li>
+ <li><a href="#httpError" title="Get the last error on a connection.">httpError</a></li>
+ <li><a href="#httpFlush" title="Flush data from a HTTP connection.">httpFlush</a></li>
+ <li><a href="#httpFlushWrite" title="Flush data in write buffer.">httpFlushWrite</a></li>
+ <li><a href="#httpFreeCredentials" title="Free an array of credentials.">httpFreeCredentials</a></li>
+ <li><a href="#httpGet" title="Send a GET request to the server.">httpGet</a></li>
+ <li><a href="#httpGetAuthString" title="Get the current authorization string.">httpGetAuthString</a></li>
+ <li><a href="#httpGetBlocking" title="Get the blocking/non-block state of a connection.">httpGetBlocking</a></li>
+ <li><a href="#httpGetCookie" title="Get any cookie data from the response.">httpGetCookie</a></li>
+ <li><a href="#httpGetDateString" title="Get a formatted date/time string from a time value.">httpGetDateString</a></li>
+ <li><a href="#httpGetDateString2" title="Get a formatted date/time string from a time value.">httpGetDateString2</a></li>
+ <li><a href="#httpGetDateTime" title="Get a time value from a formatted date/time string.">httpGetDateTime</a></li>
+ <li><a href="#httpGetFd" title="Get the file descriptor associated with a connection.">httpGetFd</a></li>
+ <li><a href="#httpGetField" title="Get a field value from a request/response.">httpGetField</a></li>
+ <li><a href="#httpGetHostByName" title="Lookup a hostname or IPv4 address, and return
address records for the specified name.">httpGetHostByName</a></li>
-<li><a href="#httpGetHostname" title="Get the FQDN for the connection or local system.">httpGetHostname</a></li>
-<li><a href="#httpGetLength" title="Get the amount of data remaining from the
+
<li><a href="#httpGetHostname" title="Get the FQDN for the connection or local system.">httpGetHostname</a></li>
+
<li><a href="#httpGetLength" title="Get the amount of data remaining from the
content-length or transfer-encoding fields.">httpGetLength</a></li>
-<li><a href="#httpGetLength2" title="Get the amount of data remaining from the
+
<li><a href="#httpGetLength2" title="Get the amount of data remaining from the
content-length or transfer-encoding fields.">httpGetLength2</a></li>
-<li><a href="#httpGetStatus" title="Get the status of the last HTTP request.">httpGetStatus</a></li>
-<li><a href="#httpGetSubField" title="Get a sub-field value.">httpGetSubField</a></li>
-<li><a href="#httpGetSubField2" title="Get a sub-field value.">httpGetSubField2</a></li>
-<li><a href="#httpGets" title="Get a line of text from a HTTP connection.">httpGets</a></li>
-<li><a href="#httpHead" title="Send a HEAD request to the server.">httpHead</a></li>
-<li><a href="#httpInitialize" title="Initialize the HTTP interface library and set the
+
<li><a href="#httpGetStatus" title="Get the status of the last HTTP request.">httpGetStatus</a></li>
+
<li><a href="#httpGetSubField" title="Get a sub-field value.">httpGetSubField</a></li>
+
<li><a href="#httpGetSubField2" title="Get a sub-field value.">httpGetSubField2</a></li>
+
<li><a href="#httpGets" title="Get a line of text from a HTTP connection.">httpGets</a></li>
+
<li><a href="#httpHead" title="Send a HEAD request to the server.">httpHead</a></li>
+
<li><a href="#httpInitialize" title="Initialize the HTTP interface library and set the
default HTTP proxy (if any).">httpInitialize</a></li>
-<li><a href="#httpMD5" title="Compute the MD5 sum of the username:group:password.">httpMD5</a></li>
-<li><a href="#httpMD5Final" title="Combine the MD5 sum of the username, group, and password
+
<li><a href="#httpMD5" title="Compute the MD5 sum of the username:group:password.">httpMD5</a></li>
+
<li><a href="#httpMD5Final" title="Combine the MD5 sum of the username, group, and password
with the server-supplied nonce value, method, and
request-uri.">httpMD5Final</a></li>
-<li><a href="#httpMD5String" title="Convert an MD5 sum to a character string.">httpMD5String</a></li>
-<li><a href="#httpOptions" title="Send an OPTIONS request to the server.">httpOptions</a></li>
-<li><a href="#httpPost" title="Send a POST request to the server.">httpPost</a></li>
-<li><a href="#httpPut" title="Send a PUT request to the server.">httpPut</a></li>
-<li><a href="#httpRead" title="Read data from a HTTP connection.">httpRead</a></li>
-<li><a href="#httpRead2" title="Read data from a HTTP connection.">httpRead2</a></li>
-<li><a href="#httpReconnect" title="Reconnect to a HTTP server.">httpReconnect</a></li>
-<li><a href="#httpSeparate" title="Separate a Universal Resource Identifier into its
+
<li><a href="#httpMD5String" title="Convert an MD5 sum to a character string.">httpMD5String</a></li>
+
<li><a href="#httpOptions" title="Send an OPTIONS request to the server.">httpOptions</a></li>
+
<li><a href="#httpPost" title="Send a POST request to the server.">httpPost</a></li>
+
<li><a href="#httpPut" title="Send a PUT request to the server.">httpPut</a></li>
+
<li><a href="#httpRead" title="Read data from a HTTP connection.">httpRead</a></li>
+
<li><a href="#httpRead2" title="Read data from a HTTP connection.">httpRead2</a></li>
+
<li><a href="#httpReconnect" title="Reconnect to a HTTP server.">httpReconnect</a></li>
+
<li><a href="#httpSeparate" title="Separate a Universal Resource Identifier into its
components.">httpSeparate</a></li>
-<li><a href="#httpSeparate2" title="Separate a Universal Resource Identifier into its
+
<li><a href="#httpSeparate2" title="Separate a Universal Resource Identifier into its
components.">httpSeparate2</a></li>
-<li><a href="#httpSeparateURI" title="Separate a Universal Resource Identifier into its
+
<li><a href="#httpSeparateURI" title="Separate a Universal Resource Identifier into its
components.">httpSeparateURI</a></li>
-<li><a href="#httpSetAuthString" title="Set the current authorization string.">httpSetAuthString</a></li>
-<li><a href="#httpSetCookie" title="Set the cookie value(s)...">httpSetCookie</a></li>
-<li><a href="#httpSetExpect" title="Set the Expect: header in a request.">httpSetExpect</a></li>
-<li><a href="#httpSetField" title="Set the value of an HTTP header.">httpSetField</a></li>
-<li><a href="#httpSetLength" title="Set the content-length and content-encoding.">httpSetLength</a></li>
-<li><a href="#httpStatus" title="Return a short string describing a HTTP status code.">httpStatus</a></li>
-<li><a href="#httpTrace" title="Send an TRACE request to the server.">httpTrace</a></li>
-<li><a href="#httpUpdate" title="Update the current HTTP state for incoming data.">httpUpdate</a></li>
-<li><a href="#httpWait" title="Wait for data available on a connection.">httpWait</a></li>
-<li><a href="#httpWrite" title="Write data to a HTTP connection.">httpWrite</a></li>
-<li><a href="#httpWrite2" title="Write data to a HTTP connection.">httpWrite2</a></li>
-<li><a href="#ippAddBoolean" title="Add a boolean attribute to an IPP message.">ippAddBoolean</a></li>
-<li><a href="#ippAddBooleans" title="Add an array of boolean values.">ippAddBooleans</a></li>
-<li><a href="#ippAddCollection" title="Add a collection value.">ippAddCollection</a></li>
-<li><a href="#ippAddCollections" title="Add an array of collection values.">ippAddCollections</a></li>
-<li><a href="#ippAddDate" title="Add a date attribute to an IPP message.">ippAddDate</a></li>
-<li><a href="#ippAddInteger" title="Add a integer attribute to an IPP message.">ippAddInteger</a></li>
-<li><a href="#ippAddIntegers" title="Add an array of integer values.">ippAddIntegers</a></li>
-<li><a href="#ippAddOctetString" title="Add an octetString value to an IPP message.">ippAddOctetString</a></li>
-<li><a href="#ippAddRange" title="Add a range of values to an IPP message.">ippAddRange</a></li>
-<li><a href="#ippAddRanges" title="Add ranges of values to an IPP message.">ippAddRanges</a></li>
-<li><a href="#ippAddResolution" title="Add a resolution value to an IPP message.">ippAddResolution</a></li>
-<li><a href="#ippAddResolutions" title="Add resolution values to an IPP message.">ippAddResolutions</a></li>
-<li><a href="#ippAddSeparator" title="Add a group separator to an IPP message.">ippAddSeparator</a></li>
-<li><a href="#ippAddString" title="Add a language-encoded string to an IPP message.">ippAddString</a></li>
-<li><a href="#ippAddStrings" title="Add language-encoded strings to an IPP message.">ippAddStrings</a></li>
-<li><a href="#ippDateToTime" title="Convert from RFC 1903 Date/Time format to UNIX time
+ <li><a href="#httpSetAuthString" title="Set the current authorization string.">httpSetAuthString</a></li>
+ <li><a href="#httpSetCookie" title="Set the cookie value(s).">httpSetCookie</a></li>
+ <li><a href="#httpSetCredentials" title="Set the credentials associated with an encrypted
+connection.">httpSetCredentials</a></li>
+ <li><a href="#httpSetExpect" title="Set the Expect: header in a request.">httpSetExpect</a></li>
+ <li><a href="#httpSetField" title="Set the value of an HTTP header.">httpSetField</a></li>
+ <li><a href="#httpSetLength" title="Set the content-length and content-encoding.">httpSetLength</a></li>
+ <li><a href="#httpStatus" title="Return a short string describing a HTTP status code.">httpStatus</a></li>
+ <li><a href="#httpTrace" title="Send an TRACE request to the server.">httpTrace</a></li>
+ <li><a href="#httpUpdate" title="Update the current HTTP state for incoming data.">httpUpdate</a></li>
+ <li><a href="#httpWait" title="Wait for data available on a connection.">httpWait</a></li>
+ <li><a href="#httpWrite" title="Write data to a HTTP connection.">httpWrite</a></li>
+ <li><a href="#httpWrite2" title="Write data to a HTTP connection.">httpWrite2</a></li>
+ <li><a href="#ippAddBoolean" title="Add a boolean attribute to an IPP message.">ippAddBoolean</a></li>
+ <li><a href="#ippAddBooleans" title="Add an array of boolean values.">ippAddBooleans</a></li>
+ <li><a href="#ippAddCollection" title="Add a collection value.">ippAddCollection</a></li>
+ <li><a href="#ippAddCollections" title="Add an array of collection values.">ippAddCollections</a></li>
+ <li><a href="#ippAddDate" title="Add a date attribute to an IPP message.">ippAddDate</a></li>
+ <li><a href="#ippAddInteger" title="Add a integer attribute to an IPP message.">ippAddInteger</a></li>
+ <li><a href="#ippAddIntegers" title="Add an array of integer values.">ippAddIntegers</a></li>
+ <li><a href="#ippAddOctetString" title="Add an octetString value to an IPP message.">ippAddOctetString</a></li>
+ <li><a href="#ippAddRange" title="Add a range of values to an IPP message.">ippAddRange</a></li>
+ <li><a href="#ippAddRanges" title="Add ranges of values to an IPP message.">ippAddRanges</a></li>
+ <li><a href="#ippAddResolution" title="Add a resolution value to an IPP message.">ippAddResolution</a></li>
+ <li><a href="#ippAddResolutions" title="Add resolution values to an IPP message.">ippAddResolutions</a></li>
+ <li><a href="#ippAddSeparator" title="Add a group separator to an IPP message.">ippAddSeparator</a></li>
+ <li><a href="#ippAddString" title="Add a language-encoded string to an IPP message.">ippAddString</a></li>
+ <li><a href="#ippAddStrings" title="Add language-encoded strings to an IPP message.">ippAddStrings</a></li>
+ <li><a href="#ippDateToTime" title="Convert from RFC 1903 Date/Time format to UNIX time
in seconds.">ippDateToTime</a></li>
-<li><a href="#ippDelete" title="Delete an IPP message.">ippDelete</a></li>
-<li><a href="#ippDeleteAttribute" title="Delete a single attribute in an IPP message.">ippDeleteAttribute</a></li>
-<li><a href="#ippErrorString" title="Return a name for the given status code.">ippErrorString</a></li>
-<li><a href="#ippErrorValue" title="Return a status code for the given name.">ippErrorValue</a></li>
-<li><a href="#ippFindAttribute" title="Find a named attribute in a request...">ippFindAttribute</a></li>
-<li><a href="#ippFindNextAttribute" title="Find the next named attribute in a request...">ippFindNextAttribute</a></li>
-<li><a href="#ippLength" title="Compute the length of an IPP message.">ippLength</a></li>
-<li><a href="#ippNew" title="Allocate a new IPP message.">ippNew</a></li>
-<li><a href="#ippNewRequest" title="Allocate a new IPP request message.">ippNewRequest</a></li>
-<li><a href="#ippOpString" title="Return a name for the given operation id.">ippOpString</a></li>
-<li><a href="#ippOpValue" title="Return an operation id for the given name.">ippOpValue</a></li>
-<li><a href="#ippPort" title="Return the default IPP port number.">ippPort</a></li>
-<li><a href="#ippRead" title="Read data for an IPP message from a HTTP connection.">ippRead</a></li>
-<li><a href="#ippReadFile" title="Read data for an IPP message from a file.">ippReadFile</a></li>
-<li><a href="#ippReadIO" title="Read data for an IPP message.">ippReadIO</a></li>
-<li><a href="#ippSetPort" title="Set the default port number.">ippSetPort</a></li>
-<li><a href="#ippTimeToDate" title="Convert from UNIX time to RFC 1903 format.">ippTimeToDate</a></li>
-<li><a href="#ippWrite" title="Write data for an IPP message to a HTTP connection.">ippWrite</a></li>
-<li><a href="#ippWriteFile" title="Write data for an IPP message to a file.">ippWriteFile</a></li>
-<li><a href="#ippWriteIO" title="Write data for an IPP message.">ippWriteIO</a></li>
-</ul>
+ <li><a href="#ippDelete" title="Delete an IPP message.">ippDelete</a></li>
+ <li><a href="#ippDeleteAttribute" title="Delete a single attribute in an IPP message.">ippDeleteAttribute</a></li>
+ <li><a href="#ippErrorString" title="Return a name for the given status code.">ippErrorString</a></li>
+ <li><a href="#ippErrorValue" title="Return a status code for the given name.">ippErrorValue</a></li>
+ <li><a href="#ippFindAttribute" title="Find a named attribute in a request...">ippFindAttribute</a></li>
+ <li><a href="#ippFindNextAttribute" title="Find the next named attribute in a request...">ippFindNextAttribute</a></li>
+ <li><a href="#ippLength" title="Compute the length of an IPP message.">ippLength</a></li>
+ <li><a href="#ippNew" title="Allocate a new IPP message.">ippNew</a></li>
+ <li><a href="#ippNewRequest" title="Allocate a new IPP request message.">ippNewRequest</a></li>
+ <li><a href="#ippOpString" title="Return a name for the given operation id.">ippOpString</a></li>
+ <li><a href="#ippOpValue" title="Return an operation id for the given name.">ippOpValue</a></li>
+ <li><a href="#ippPort" title="Return the default IPP port number.">ippPort</a></li>
+ <li><a href="#ippRead" title="Read data for an IPP message from a HTTP connection.">ippRead</a></li>
+ <li><a href="#ippReadFile" title="Read data for an IPP message from a file.">ippReadFile</a></li>
+ <li><a href="#ippReadIO" title="Read data for an IPP message.">ippReadIO</a></li>
+ <li><a href="#ippSetPort" title="Set the default port number.">ippSetPort</a></li>
+ <li><a href="#ippTagString" title="Return the tag name corresponding to a tag value.">ippTagString</a></li>
+ <li><a href="#ippTagValue" title="Return the tag value corresponding to a tag name.">ippTagValue</a></li>
+ <li><a href="#ippTimeToDate" title="Convert from UNIX time to RFC 1903 format.">ippTimeToDate</a></li>
+ <li><a href="#ippWrite" title="Write data for an IPP message to a HTTP connection.">ippWrite</a></li>
+ <li><a href="#ippWriteFile" title="Write data for an IPP message to a file.">ippWriteFile</a></li>
+ <li><a href="#ippWriteIO" title="Write data for an IPP message.">ippWriteIO</a></li>
+</ul></li>
<li><a href="#TYPES">Data Types</a><ul class="code">
+ <li><a href="#gss_auth_identity_desc" title="Local functions...">gss_auth_identity_desc</a></li>
+ <li><a href="#http_addr_t" title="Socket address union, which
+makes using IPv6 and other
+address types easier and
+more portable. ">http_addr_t</a></li>
<li><a href="#http_addrlist_t" title="Socket address list, which is
used to enumerate all of the
addresses that are associated
with a hostname. ">http_addrlist_t</a></li>
<li><a href="#http_auth_t" title="HTTP authentication types">http_auth_t</a></li>
+ <li><a href="#http_credential_t" title="Credential data ">http_credential_t</a></li>
<li><a href="#http_encoding_t" title="HTTP transfer encoding values">http_encoding_t</a></li>
<li><a href="#http_encryption_t" title="HTTP encryption values">http_encryption_t</a></li>
+ <li><a href="#http_field_t" title="HTTP field names">http_field_t</a></li>
+ <li><a href="#http_keepalive_t" title="HTTP keep-alive values">http_keepalive_t</a></li>
+ <li><a href="#http_state_t" title="HTTP state values; states
+are server-oriented...">http_state_t</a></li>
+ <li><a href="#http_status_t" title="HTTP status codes">http_status_t</a></li>
<li><a href="#http_t" title="HTTP connection type">http_t</a></li>
+ <li><a href="#http_uri_coding_t" title="URI en/decode flags">http_uri_coding_t</a></li>
+ <li><a href="#http_uri_status_t" title="URI separation status ">http_uri_status_t</a></li>
+ <li><a href="#http_version_t" title="HTTP version numbers">http_version_t</a></li>
<li><a href="#ipp_attribute_t" title="Attribute">ipp_attribute_t</a></li>
+ <li><a href="#ipp_finish_t" title="Finishings">ipp_finish_t</a></li>
<li><a href="#ipp_iocb_t" title="IPP IO Callback Function ">ipp_iocb_t</a></li>
+ <li><a href="#ipp_jstate_t" title="Job states">ipp_jstate_t</a></li>
+ <li><a href="#ipp_op_t" title="IPP operations">ipp_op_t</a></li>
+ <li><a href="#ipp_orient_t" title="Orientation values">ipp_orient_t</a></li>
+ <li><a href="#ipp_pstate_t" title="Printer states">ipp_pstate_t</a></li>
+ <li><a href="#ipp_quality_t" title="Qualities">ipp_quality_t</a></li>
<li><a href="#ipp_request_t" title="Request Header">ipp_request_t</a></li>
+ <li><a href="#ipp_res_t" title="Resolution units">ipp_res_t</a></li>
+ <li><a href="#ipp_state_t" title="IPP states">ipp_state_t</a></li>
<li><a href="#ipp_t" title="Attribute Value">ipp_t</a></li>
- <li><a href="#ipp_uchar_t" title="IPP status codes...">ipp_uchar_t</a></li>
- <li><a href="#ipp_value_t" title="New in CUPS 1.1.19">ipp_value_t</a></li>
+ <li><a href="#ipp_uchar_t" title="IPP status codes">ipp_uchar_t</a></li>
+ <li><a href="#ipp_tag_t" title="Format tags for attributes">ipp_tag_t</a></li>
+ <li><a href="#ipp_value_t" title="Attribute Value">ipp_value_t</a></li>
</ul></li>
<li><a href="#STRUCTURES">Structures</a><ul class="code">
+ <li><a href="#gss_auth_identity" title="Local functions...">gss_auth_identity</a></li>
<li><a href="#http_addrlist_s" title="Socket address list, which is
used to enumerate all of the
addresses that are associated
with a hostname. ">http_addrlist_s</a></li>
+ <li><a href="#http_credential_s" title="Credential data ">http_credential_s</a></li>
<li><a href="#ipp_attribute_s" title="Attribute">ipp_attribute_s</a></li>
<li><a href="#ipp_s" title="IPP Request/Response/Notification">ipp_s</a></li>
</ul></li>
<li><a href="#UNIONS">Unions</a><ul class="code">
<li><a href="#ipp_request_u" title="Request Header">ipp_request_u</a></li>
- <li><a href="#ipp_value_u" title="New in CUPS 1.1.19">ipp_value_u</a></li>
+ <li><a href="#ipp_value_u" title="Attribute Value">ipp_value_u</a></li>
</ul></li>
<li><a href="#ENUMERATIONS">Constants</a><ul class="code">
<li><a href="#http_auth_e" title="HTTP authentication types">http_auth_e</a></li>
<li><a href="#http_encoding_e" title="HTTP transfer encoding values">http_encoding_e</a></li>
<li><a href="#http_encryption_e" title="HTTP encryption values">http_encryption_e</a></li>
<li><a href="#http_field_e" title="HTTP field names">http_field_e</a></li>
- <li><a href="#http_keepalive_e" title="Types and structures...">http_keepalive_e</a></li>
- <li><a href="#http_state_e" title="">http_state_e</a></li>
+ <li><a href="#http_keepalive_e" title="HTTP keep-alive values">http_keepalive_e</a></li>
+ <li><a href="#http_state_e" title="HTTP state values; states
+are server-oriented...">http_state_e</a></li>
<li><a href="#http_status_e" title="HTTP status codes">http_status_e</a></li>
- <li><a href="#http_uri_coding_e" title="">http_uri_coding_e</a></li>
- <li><a href="#http_uri_status_e" title="">http_uri_status_e</a></li>
- <li><a href="#http_version_e" title="">http_version_e</a></li>
- <li><a href="#ipp_finish_e" title="">ipp_finish_e</a></li>
- <li><a href="#ipp_jstate_e" title="">ipp_jstate_e</a></li>
- <li><a href="#ipp_op_e" title="">ipp_op_e</a></li>
- <li><a href="#ipp_orient_e" title="">ipp_orient_e</a></li>
- <li><a href="#ipp_pstate_e" title="">ipp_pstate_e</a></li>
- <li><a href="#ipp_quality_e" title="">ipp_quality_e</a></li>
- <li><a href="#ipp_res_e" title="Types and structures...">ipp_res_e</a></li>
- <li><a href="#ipp_state_e" title="">ipp_state_e</a></li>
- <li><a href="#ipp_status_e" title="IPP status codes...">ipp_status_e</a></li>
- <li><a href="#ipp_tag_e" title="Format tags for attributes...">ipp_tag_e</a></li>
+ <li><a href="#http_uri_coding_e" title="URI en/decode flags">http_uri_coding_e</a></li>
+ <li><a href="#http_uri_status_e" title="URI separation status ">http_uri_status_e</a></li>
+ <li><a href="#http_version_e" title="HTTP version numbers">http_version_e</a></li>
+ <li><a href="#ipp_finish_e" title="Finishings">ipp_finish_e</a></li>
+ <li><a href="#ipp_jstate_e" title="Job states">ipp_jstate_e</a></li>
+ <li><a href="#ipp_op_e" title="IPP operations">ipp_op_e</a></li>
+ <li><a href="#ipp_orient_e" title="Orientation values">ipp_orient_e</a></li>
+ <li><a href="#ipp_pstate_e" title="Printer states">ipp_pstate_e</a></li>
+ <li><a href="#ipp_quality_e" title="Qualities">ipp_quality_e</a></li>
+ <li><a href="#ipp_res_e" title="Resolution units">ipp_res_e</a></li>
+ <li><a href="#ipp_state_e" title="IPP states">ipp_state_e</a></li>
+ <li><a href="#ipp_status_e" title="IPP status codes">ipp_status_e</a></li>
+ <li><a href="#ipp_tag_e" title="Format tags for attributes">ipp_tag_e</a></li>
</ul></li>
</ul>
<!--
- "$Id: api-httpipp.shtml 7258 2008-01-28 00:15:05Z mike $"
+ "$Id$"
- HTTP and IPP API introduction for the Common UNIX Printing System (CUPS).
+ HTTP and IPP API introduction for CUPS.
- Copyright 2007-2008 by Apple Inc.
+ Copyright 2007-2011 by Apple Inc.
Copyright 1997-2006 by Easy Software Products, all rights reserved.
These coded instructions, statements, and computer programs are the
/* Loop for authentication */
do
{
- status = a href='#cupsSendRequest'>cupsSendRequest</a>(CUPS_HTTP_DEFAULT, request, "/");
+ status = <a href='#cupsSendRequest'>cupsSendRequest</a>(CUPS_HTTP_DEFAULT, request, "/");
if (status == HTTP_UNAUTHORIZED)
{
<a href='#ippDelete'>ippDelete</a>(request);
</pre>
<h2 class="title"><a name="FUNCTIONS">Functions</a></h2>
-<h3 class="function"><span class="info"> CUPS 1.1.20 </span><a name="cupsDoAuthentication">cupsDoAuthentication</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.20
/Mac OS X 10.4 </span><a name="cupsDoAuthentication">cupsDoAuthentication</a></h3>
<p class="description">Authenticate a request.</p>
<p class="code">
int cupsDoAuthentication (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection to server</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>method</dt>
<dd class="description">Request method ("GET", "POST", "PUT")</dd>
<dt>resource</dt>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>request</dt>
<dd class="description">IPP request</dd>
<dt>resource</dt>
<dd class="description">HTTP resource for POST</dd>
<dt>filename</dt>
-<dd class="description">File to send or NULL for none</dd>
+<dd class="description">File to send or <code>NULL</code> for none</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Response data</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">This function sends the IPP request to the specified server, retrying
-and authenticating as necessary. The request is freed with ippDelete()
+and authenticating as necessary. The request is freed with <a href="#ippDelete"><code>ippDelete</code></a>
after receiving a valid IPP response.</p>
-<h3 class="function"><span class="info"> CUPS 1.3 </span><a name="cupsDoIORequest">cupsDoIORequest</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.3
/Mac OS X 10.5 </span><a name="cupsDoIORequest">cupsDoIORequest</a></h3>
<p class="description">Do an IPP request with file descriptors.</p>
<p class="code">
<a href="#ipp_t">ipp_t</a> *cupsDoIORequest (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>request</dt>
<dd class="description">IPP request</dd>
<dt>resource</dt>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>request</dt>
<dd class="description">IPP request</dd>
<dt>resource</dt>
<p class="discussion">This function adds operation, job, and then subscription attributes,
in that order. Use the cupsEncodeOptions2() function to add attributes
for a single group.</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="cupsEncodeOptions2">cupsEncodeOptions2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="cupsEncodeOptions2">cupsEncodeOptions2</a></h3>
<p class="description">Encode printer options into IPP attributes for a group.</p>
<p class="code">
void cupsEncodeOptions2 (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
int num_options,<br>
cups_option_t *options,<br>
- ipp_tag_t group_tag<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group_tag<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
to add the standard groups.
</p>
-<h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsGetResponse">cupsGetResponse</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </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 *include_schemes,<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>include_schemes</dt>
+<dd class="description">Comma-separated URI schemes to include or <code>CUPS_INCLUDE_ALL</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 "include_schemes" and "exclude_schemes"
+parameters provide comma-delimited lists of backends to include or omit from
+the request respectively.
+
+</p>
+<h3 class="function"><span class="info"> CUPS 1.1.20/Mac OS X 10.4 </span><a name="cupsGetFd">cupsGetFd</a></h3>
+<p class="description">Get a file from the server.</p>
+<p class="code">
+<a href="#http_status_t">http_status_t</a> 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/Mac OS X 10.4 </span><a name="cupsGetFile">cupsGetFile</a></h3>
+<p class="description">Get a file from the server.</p>
+<p class="code">
+<a href="#http_status_t">http_status_t</a> 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/Mac OS X 10.6 </span><a name="cupsGetResponse">cupsGetResponse</a></h3>
<p class="description">Get a response to an IPP request.</p>
<p class="code">
<a href="#ipp_t">ipp_t</a> *cupsGetResponse (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>resource</dt>
<dd class="description">HTTP resource for POST</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
-<p class="description">Response or NULL on HTTP error</p>
+<p class="description">Response or <code>NULL</code> on HTTP error</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Use this function to get the response for an IPP request sent using
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.4 </span><a name="cupsReadResponseData">cupsReadResponseData</a></h3>
+<h3 class="function"><a name="cupsLastError">cupsLastError</a></h3>
+<p class="description">Return the last IPP status code.</p>
+<p class="code">
+ipp_status_t cupsLastError (void);</p>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">IPP status code from last request</p>
+<h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsLastErrorString">cupsLastErrorString</a></h3>
+<p class="description">Return the last IPP status-message.</p>
+<p class="code">
+const char *cupsLastErrorString (void);</p>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">status-message text from last request</p>
+<h3 class="function"><span class="info"> CUPS 1.1.20/Mac OS X 10.4 </span><a name="cupsPutFd">cupsPutFd</a></h3>
+<p class="description">Put a file on the server.</p>
+<p class="code">
+<a href="#http_status_t">http_status_t</a> 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/Mac OS X 10.4 </span><a name="cupsPutFile">cupsPutFile</a></h3>
+<p class="description">Put a file on the server.</p>
+<p class="code">
+<a href="#http_status_t">http_status_t</a> 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/Mac OS X 10.6 </span><a name="cupsReadResponseData">cupsReadResponseData</a></h3>
<p class="description">Read additional data after the IPP response.</p>
<p class="code">
ssize_t cupsReadResponseData (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>buffer</dt>
<dd class="description">Buffer to use</dd>
<dt>length</dt>
files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively.
</p>
-<h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsSendRequest">cupsSendRequest</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.4
/Mac OS X 10.6 </span><a name="cupsSendRequest">cupsSendRequest</a></h3>
<p class="description">Send an IPP request.</p>
<p class="code">
-http_status_t cupsSendRequest (<br>
+<a href="#http_status_t">http_status_t</a> cupsSendRequest (<br>
<a href="#http_t">http_t</a> *http,<br>
<a href="#ipp_t">ipp_t</a> *request,<br>
const char *resource,<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>request</dt>
<dd class="description">IPP request</dd>
<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>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Use httpWrite() to write any additional data (document, PPD file, etc.)
for the request, cupsGetResponse() to get the IPP response, and httpRead()
-to read any additional data following the response. Only one request can be
+to read any additional data following the response. Only one request can be
sent/queued at a time.<br>
<br>
Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the
request is not freed.
</p>
-<h3 class="function"><span class="info"> CUPS 1.4 </span><a name="cupsWriteRequestData">cupsWriteRequestData</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.4
/Mac OS X 10.6 </span><a name="cupsWriteRequestData">cupsWriteRequestData</a></h3>
<p class="description">Write additional data after an IPP request.</p>
<p class="code">
-http_status_t cupsWriteRequestData (<br>
+<a href="#http_status_t">http_status_t</a> cupsWriteRequestData (<br>
<a href="#http_t">http_t</a> *http,<br>
const char *buffer,<br>
size_t length<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection or CUPS_HTTP_DEFAULT</dd>
+<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd>
<dt>buffer</dt>
<dd class="description">Bytes to write</dd>
<dt>length</dt>
<dd class="description">Number of bytes to write</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
-<p class="description">HTTP_CONTINUE if OK or HTTP status on error</p>
+<p class="description"><code>HTTP_CONTINUE</code> if OK or HTTP status on error</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">This function is used after <a href="#cupsSendRequest"><code>cupsSendRequest</code></a> to provide a PPD and
+after <a href="#cupsStartDocument"><code>cupsStartDocument</code></a> to provide a document file.
+
+</p>
+<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpAddCredential">httpAddCredential</a></h3>
+<p class="description">Allocates and adds a single credential to an array.</p>
+<p class="code">
+int httpAddCredential (<br>
+ cups_array_t *credentials,<br>
+ const void *data,<br>
+ size_t datalen<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>credentials</dt>
+<dd class="description">Credentials array</dd>
+<dt>data</dt>
+<dd class="description">PEM-encoded X.509 data</dd>
+<dt>datalen</dt>
+<dd class="description">Length of data</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">0 on success, -1 on error</p>
<h4 class="discussion">Discussion</h4>
-<p class="discussion">This function is used after cupsSendRequest() or cupsStartDocument()
-to provide a PPD or document file as needed.
+<p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrAny">httpAddrAny</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrAny">httpAddrAny</a></h3>
<p class="description">Check for the "any" address.</p>
<p class="code">
int httpAddrAny (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">1 if "any", 0 otherwise</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrEqual">httpAddrEqual</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrEqual">httpAddrEqual</a></h3>
<p class="description">Compare two addresses.</p>
<p class="code">
int httpAddrEqual (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">1 if equal, 0 if not</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrLength">httpAddrLength</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrLength">httpAddrLength</a></h3>
<p class="description">Return the length of the address in bytes.</p>
<p class="code">
int httpAddrLength (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Length in bytes</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrLocalhost">httpAddrLocalhost</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrLocalhost">httpAddrLocalhost</a></h3>
<p class="description">Check for the local loopback address.</p>
<p class="code">
int httpAddrLocalhost (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">1 if local host, 0 otherwise</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrLookup">httpAddrLookup</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrLookup">httpAddrLookup</a></h3>
<p class="description">Lookup the hostname associated with the address.</p>
<p class="code">
char *httpAddrLookup (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Host name</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAddrString">httpAddrString</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAddrString">httpAddrString</a></h3>
<p class="description">Convert an address to a numeric string.</p>
<p class="code">
char *httpAddrString (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Numeric address string</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAssembleURI">httpAssembleURI</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAssembleURI">httpAssembleURI</a></h3>
<p class="description">Assemble a uniform resource identifier from its
components.</p>
<p class="code">
-http_uri_status_t httpAssembleURI (<br>
- http_uri_coding_t encoding,<br>
+<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI (<br>
+ <a href="#http_uri_coding_t">http_uri_coding_t</a> encoding,<br>
char *uri,<br>
int urilen,<br>
const char *scheme,<br>
URI string.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpAssembleURIf">httpAssembleURIf</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpAssembleURIf">httpAssembleURIf</a></h3>
<p class="description">Assemble a uniform resource identifier from its
components with a formatted resource.</p>
<p class="code">
-http_uri_status_t httpAssembleURIf (<br>
- http_uri_coding_t encoding,<br>
+<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf (<br>
+ <a href="#http_uri_coding_t">http_uri_coding_t</a> encoding,<br>
char *uri,<br>
int urilen,<br>
const char *scheme,<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>b</dt>
<dd class="description">1 = blocking, 0 = non-blocking</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">0 = no data, 1 = data available</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="httpClearCookie">httpClearCookie</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="httpClearCookie">httpClearCookie</a></h3>
<p class="description">Clear the cookie value(s).</p>
<p class="code">
void httpClearCookie (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h3 class="function"><a name="httpClearFields">httpClearFields</a></h3>
<p class="description">Clear HTTP request fields.</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h3 class="function"><a name="httpClose">httpClose</a></h3>
-<p class="description">Close an HTTP connection...</p>
+<p class="description">Close an HTTP connection.</p>
<p class="code">
void httpClose (<br>
<a href="#http_t">http_t</a> *http<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
-<h3 class="function"><a name="httpConnect">httpConnect</a></h3>
+<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpConnect">httpConnect</a></h3>
<p class="description">Connect to a HTTP server.</p>
<p class="code">
<a href="#http_t">http_t</a> *httpConnect (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New HTTP connection</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">This function is deprecated - use <a href="#httpConnectEncrypt"><code>httpConnectEncrypt</code></a> instead.
+
+</p>
<h3 class="function"><a name="httpConnectEncrypt">httpConnectEncrypt</a></h3>
<p class="description">Connect to a HTTP server using encryption.</p>
<p class="code">
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New HTTP connection</p>
+<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpCopyCredentials">httpCopyCredentials</a></h3>
+<p class="description">Copy the credentials associated with an encrypted
+connection.</p>
+<p class="code">
+int httpCopyCredentials (<br>
+ <a href="#http_t">http_t</a> *http,<br>
+ cups_array_t **credentials<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>http</dt>
+<dd class="description">Connection to server</dd>
+<dt>credentials</dt>
+<dd class="description">Array of credentials</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Status of call (0 = success)</p>
<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpDecode64">httpDecode64</a></h3>
<p class="description">Base64-decode a string.</p>
<p class="code">
which provides buffer length arguments.
</p>
-<h3 class="function"><span class="info"> CUPS 1.1.21 </span><a name="httpDecode64_2">httpDecode64_2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.21
/Mac OS X 10.4 </span><a name="httpDecode64_2">httpDecode64_2</a></h3>
<p class="description">Base64-decode a string.</p>
<p class="code">
char *httpDecode64_2 (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI to delete</dd>
</dl>
which provides buffer length arguments.
</p>
-<h3 class="function"><span class="info"> CUPS 1.1.21 </span><a name="httpEncode64_2">httpEncode64_2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.21
/Mac OS X 10.4 </span><a name="httpEncode64_2">httpEncode64_2</a></h3>
<p class="description">Base64-encode a string.</p>
<p class="code">
char *httpEncode64_2 (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>e</dt>
<dd class="description">New encryption preference</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Error code (errno) value</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpFlushWrite">httpFlushWrite</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpFlushWrite">httpFlushWrite</a></h3>
<p class="description">Flush data in write buffer.</p>
<p class="code">
int httpFlushWrite (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Bytes written or -1 on error</p>
+<h3 class="function"><a name="httpFreeCredentials">httpFreeCredentials</a></h3>
+<p class="description">Free an array of credentials.</p>
+<p class="code">
+void httpFreeCredentials (<br>
+ cups_array_t *credentials<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>credentials</dt>
+<dd class="description">Array of credentials</dd>
+</dl>
<h3 class="function"><a name="httpGet">httpGet</a></h3>
<p class="description">Send a GET request to the server.</p>
<p class="code">
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI to get</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Status of call (0 = success)</p>
-<h3 class="function"><span class="info"> CUPS 1.3 </span><a name="httpGetAuthString">httpGetAuthString</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.3
/Mac OS X 10.5 </span><a name="httpGetAuthString">httpGetAuthString</a></h3>
<p class="description">Get the current authorization string.</p>
<p class="code">
char *httpGetAuthString (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Authorization string</p>
value.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetBlocking">httpGetBlocking</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetBlocking">httpGetBlocking</a></h3>
<p class="description">Get the blocking/non-block state of a connection.</p>
<p class="code">
int httpGetBlocking (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">1 if blocking, 0 if non-blocking</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="httpGetCookie">httpGetCookie</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="httpGetCookie">httpGetCookie</a></h3>
<p class="description">Get any cookie data from the response.</p>
<p class="code">
const char *httpGetCookie (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Date/time string</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetDateString2">httpGetDateString2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetDateString2">httpGetDateString2</a></h3>
<p class="description">Get a formatted date/time string from a time value.</p>
<p class="code">
const char *httpGetDateString2 (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">UNIX time</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetFd">httpGetFd</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetFd">httpGetFd</a></h3>
<p class="description">Get the file descriptor associated with a connection.</p>
<p class="code">
int httpGetFd (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">File descriptor or -1 if none</p>
<p class="code">
const char *httpGetField (<br>
<a href="#http_t">http_t</a> *http,<br>
- http_field_t field<br>
+ <a href="#http_field_t">http_field_t</a> field<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>field</dt>
<dd class="description">Field to get</dd>
</dl>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Host entry</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetHostname">httpGetHostname</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetHostname">httpGetHostname</a></h3>
<p class="description">Get the FQDN for the connection or local system.</p>
<p class="code">
const char *httpGetHostname (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Content length</p>
2^31 - 1; use httpGetLength2() instead.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetLength2">httpGetLength2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetLength2">httpGetLength2</a></h3>
<p class="description">Get the amount of data remaining from the
content-length or transfer-encoding fields.</p>
<p class="code">
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Content length</p>
content larger than 2^31 - 1.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetStatus">httpGetStatus</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetStatus">httpGetStatus</a></h3>
<p class="description">Get the status of the last HTTP request.</p>
<p class="code">
-http_status_t httpGetStatus (<br>
+<a href="#http_status_t">http_status_t</a> httpGetStatus (<br>
<a href="#http_t">http_t</a> *http<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">HTTP status</p>
<p class="code">
char *httpGetSubField (<br>
<a href="#http_t">http_t</a> *http,<br>
- http_field_t field,<br>
+ <a href="#http_field_t">http_field_t</a> field,<br>
const char *name,<br>
char *value<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>field</dt>
<dd class="description">Field index</dd>
<dt>name</dt>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Value or NULL</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpGetSubField2">httpGetSubField2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpGetSubField2">httpGetSubField2</a></h3>
<p class="description">Get a sub-field value.</p>
<p class="code">
char *httpGetSubField2 (<br>
<a href="#http_t">http_t</a> *http,<br>
- http_field_t field,<br>
+ <a href="#http_field_t">http_field_t</a> field,<br>
const char *name,<br>
char *value,<br>
int valuelen<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>field</dt>
<dd class="description">Field index</dd>
<dt>name</dt>
<dt>length</dt>
<dd class="description">Max length of buffer</dd>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Line or NULL</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI for head</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI for options</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI for post</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI to put</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>buffer</dt>
<dd class="description">Buffer for data</dd>
<dt>length</dt>
read more than 2GB of data.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpRead2">httpRead2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpRead2">httpRead2</a></h3>
<p class="description">Read data from a HTTP connection.</p>
<p class="code">
ssize_t httpRead2 (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>buffer</dt>
<dd class="description">Buffer for data</dd>
<dt>length</dt>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">0 on success, non-zero on failure</p>
<p class="discussion">This function is deprecated; use the httpSeparateURI() function instead.
</p>
-<h3 class="function"><span class="info"> CUPS 1.1.21 </span><a name="httpSeparate2">httpSeparate2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.21
/Mac OS X 10.4 </span><a name="httpSeparate2">httpSeparate2</a></h3>
<p class="description">Separate a Universal Resource Identifier into its
components.</p>
<p class="code">
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpSeparateURI">httpSeparateURI</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpSeparateURI">httpSeparateURI</a></h3>
<p class="description">Separate a Universal Resource Identifier into its
components.</p>
<p class="code">
-http_uri_status_t httpSeparateURI (<br>
- http_uri_coding_t decoding,<br>
+<a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI (<br>
+ <a href="#http_uri_coding_t">http_uri_coding_t</a> decoding,<br>
const char *uri,<br>
char *scheme,<br>
int schemelen,<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Result of separation</p>
-<h3 class="function"><span class="info"> CUPS 1.3 </span><a name="httpSetAuthString">httpSetAuthString</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.3
/Mac OS X 10.5 </span><a name="httpSetAuthString">httpSetAuthString</a></h3>
<p class="description">Set the current authorization string.</p>
<p class="code">
void httpSetAuthString (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>scheme</dt>
<dd class="description">Auth scheme (NULL to clear it)</dd>
<dt>data</dt>
httpHead(), httpOptions(), httpPost, or httpPut().
</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="httpSetCookie">httpSetCookie</a></h3>
-<p class="description">Set the cookie value(s)...</p>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="httpSetCookie">httpSetCookie</a></h3>
+<p class="description">Set the cookie value(s).</p>
<p class="code">
void httpSetCookie (<br>
<a href="#http_t">http_t</a> *http,<br>
<dt>cookie</dt>
<dd class="description">Cookie string</dd>
</dl>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpSetExpect">httpSetExpect</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpSetCredentials">httpSetCredentials</a></h3>
+<p class="description">Set the credentials associated with an encrypted
+connection.</p>
+<p class="code">
+int httpSetCredentials (<br>
+ <a href="#http_t">http_t</a> *http,<br>
+ cups_array_t *credentials<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>http</dt>
+<dd class="description">Connection to server</dd>
+<dt>credentials</dt>
+<dd class="description">Array of credentials</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Status of call (0 = success)</p>
+<h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="httpSetExpect">httpSetExpect</a></h3>
<p class="description">Set the Expect: header in a request.</p>
<p class="code">
void httpSetExpect (<br>
<a href="#http_t">http_t</a> *http,<br>
- http_status_t expect<br>
+ <a href="#http_status_t">http_status_t</a> expect<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>expect</dt>
<dd class="description">HTTP status to expect (HTTP_CONTINUE)</dd>
</dl>
<p class="code">
void httpSetField (<br>
<a href="#http_t">http_t</a> *http,<br>
- http_field_t field,<br>
+ <a href="#http_field_t">http_field_t</a> field,<br>
const char *value<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>field</dt>
<dd class="description">Field index</dd>
<dt>value</dt>
<dd class="description">Value</dd>
</dl>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpSetLength">httpSetLength</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpSetLength">httpSetLength</a></h3>
<p class="description">Set the content-length and content-encoding.</p>
<p class="code">
void httpSetLength (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>length</dt>
<dd class="description">Length (0 for chunked)</dd>
</dl>
<p class="description">Return a short string describing a HTTP status code.</p>
<p class="code">
const char *httpStatus (<br>
- http_status_t status<br>
+ <a href="#http_status_t">http_status_t</a> status<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dd class="description">HTTP status code</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
-<p class="description">String or NULL</p>
+<p class="description">Localized status string</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">The returned string is localized to the current POSIX locale and is based
+on the status strings defined in RFC 2616.</p>
<h3 class="function"><a name="httpTrace">httpTrace</a></h3>
<p class="description">Send an TRACE request to the server.</p>
<p class="code">
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>uri</dt>
<dd class="description">URI for trace</dd>
</dl>
<h3 class="function"><a name="httpUpdate">httpUpdate</a></h3>
<p class="description">Update the current HTTP state for incoming data.</p>
<p class="code">
-http_status_t httpUpdate (<br>
+<a href="#http_status_t">http_status_t</a> httpUpdate (<br>
<a href="#http_t">http_t</a> *http<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">HTTP status</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="httpWait">httpWait</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="httpWait">httpWait</a></h3>
<p class="description">Wait for data available on a connection.</p>
<p class="code">
int httpWait (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>msec</dt>
<dd class="description">Milliseconds to wait</dd>
</dl>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>buffer</dt>
<dd class="description">Buffer for data</dd>
<dt>length</dt>
write more than 2GB of data.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="httpWrite2">httpWrite2</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="httpWrite2">httpWrite2</a></h3>
<p class="description">Write data to a HTTP connection.</p>
<p class="code">
ssize_t httpWrite2 (<br>
<h4 class="parameters">Parameters</h4>
<dl>
<dt>http</dt>
-<dd class="description">HTTP connection</dd>
+<dd class="description">Connection to server</dd>
<dt>buffer</dt>
<dd class="description">Buffer for data</dd>
<dt>length</dt>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
char value<br>
);</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
int num_values,<br>
const char *values<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New attribute</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="ippAddCollection">ippAddCollection</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="ippAddCollection">ippAddCollection</a></h3>
<p class="description">Add a collection value.</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollection (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
<a href="#ipp_t">ipp_t</a> *value<br>
);</p>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New attribute</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="ippAddCollections">ippAddCollections</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="ippAddCollections">ippAddCollections</a></h3>
<p class="description">Add an array of collection values.</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollections (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
int num_values,<br>
const <a href="#ipp_t">ipp_t</a> **values<br>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
const <a href="#ipp_uchar_t">ipp_uchar_t</a> *value<br>
);</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddInteger (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
- ipp_tag_t type,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type,<br>
const char *name,<br>
int value<br>
);</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddIntegers (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
- ipp_tag_t type,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type,<br>
const char *name,<br>
int num_values,<br>
const int *values<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New attribute</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippAddOctetString">ippAddOctetString</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippAddOctetString">ippAddOctetString</a></h3>
<p class="description">Add an octetString value to an IPP message.</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOctetString (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
const void *data,<br>
int datalen<br>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
int lower,<br>
int upper<br>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
int num_values,<br>
const int *lower,<br>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
- ipp_res_t units,<br>
+ <a href="#ipp_res_t">ipp_res_t</a> units,<br>
int xres,<br>
int yres<br>
);</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
const char *name,<br>
int num_values,<br>
- ipp_res_t units,<br>
+ <a href="#ipp_res_t">ipp_res_t</a> units,<br>
const int *xres,<br>
const int *yres<br>
);</p>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddString (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
- ipp_tag_t type,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type,<br>
const char *name,<br>
const char *charset,<br>
const char *value<br>
<p class="code">
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStrings (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
- ipp_tag_t group,<br>
- ipp_tag_t type,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group,<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type,<br>
const char *name,<br>
int num_values,<br>
const char *charset,<br>
<dt>ipp</dt>
<dd class="description">IPP message</dd>
</dl>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="ippDeleteAttribute">ippDeleteAttribute</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="ippDeleteAttribute">ippDeleteAttribute</a></h3>
<p class="description">Delete a single attribute in an IPP message.</p>
<p class="code">
void ippDeleteAttribute (<br>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Text string</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippErrorValue">ippErrorValue</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippErrorValue">ippErrorValue</a></h3>
<p class="description">Return a status code for the given name.</p>
<p class="code">
ipp_status_t ippErrorValue (<br>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
const char *name,<br>
- ipp_tag_t type<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute (<br>
<a href="#ipp_t">ipp_t</a> *ipp,<br>
const char *name,<br>
- ipp_tag_t type<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> type<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
<a href="#ipp_t">ipp_t</a> *ippNew (void);</p>
<h4 class="returnvalue">Return Value</h4>
<p class="description">New IPP message</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippNewRequest">ippNewRequest</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippNewRequest">ippNewRequest</a></h3>
<p class="description">Allocate a new IPP request message.</p>
<p class="code">
<a href="#ipp_t">ipp_t</a> *ippNewRequest (<br>
- ipp_op_t op<br>
+ <a href="#ipp_op_t">ipp_op_t</a> op<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
attributes-natural-language value is derived from the current locale.
</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippOpString">ippOpString</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippOpString">ippOpString</a></h3>
<p class="description">Return a name for the given operation id.</p>
<p class="code">
const char *ippOpString (<br>
- ipp_op_t op<br>
+ <a href="#ipp_op_t">ipp_op_t</a> op<br>
);</p>
<h4 class="parameters">Parameters</h4>
<dl>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Name</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippOpValue">ippOpValue</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippOpValue">ippOpValue</a></h3>
<p class="description">Return an operation id for the given name.</p>
<p class="code">
-ipp_op_t ippOpValue (<br>
+<a href="#ipp_op_t">ipp_op_t</a> ippOpValue (<br>
const char *name<br>
);</p>
<h4 class="parameters">Parameters</h4>
<h3 class="function"><a name="ippRead">ippRead</a></h3>
<p class="description">Read data for an IPP message from a HTTP connection.</p>
<p class="code">
-ipp_state_t ippRead (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippRead (<br>
<a href="#http_t">http_t</a> *http,<br>
<a href="#ipp_t">ipp_t</a> *ipp<br>
);</p>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Current state</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="ippReadFile">ippReadFile</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="ippReadFile">ippReadFile</a></h3>
<p class="description">Read data for an IPP message from a file.</p>
<p class="code">
-ipp_state_t ippReadFile (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippReadFile (<br>
int fd,<br>
<a href="#ipp_t">ipp_t</a> *ipp<br>
);</p>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Current state</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippReadIO">ippReadIO</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippReadIO">ippReadIO</a></h3>
<p class="description">Read data for an IPP message.</p>
<p class="code">
-ipp_state_t ippReadIO (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippReadIO (<br>
void *src,<br>
<a href="#ipp_iocb_t">ipp_iocb_t</a> cb,<br>
int blocking,<br>
<dt>p</dt>
<dd class="description">Port number to use</dd>
</dl>
+<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="ippTagString">ippTagString</a></h3>
+<p class="description">Return the tag name corresponding to a tag value.</p>
+<p class="code">
+const char *ippTagString (<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> tag<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>tag</dt>
+<dd class="description">Tag value</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Tag name</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">The returned names are defined in RFC 2911 and 3382.
+
+</p>
+<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="ippTagValue">ippTagValue</a></h3>
+<p class="description">Return the tag value corresponding to a tag name.</p>
+<p class="code">
+<a href="#ipp_tag_t">ipp_tag_t</a> ippTagValue (<br>
+ const char *name<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>name</dt>
+<dd class="description">Tag name</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Tag value</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">The tag names are defined in RFC 2911 and 3382.
+
+</p>
<h3 class="function"><a name="ippTimeToDate">ippTimeToDate</a></h3>
<p class="description">Convert from UNIX time to RFC 1903 format.</p>
<p class="code">
<h3 class="function"><a name="ippWrite">ippWrite</a></h3>
<p class="description">Write data for an IPP message to a HTTP connection.</p>
<p class="code">
-ipp_state_t ippWrite (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippWrite (<br>
<a href="#http_t">http_t</a> *http,<br>
<a href="#ipp_t">ipp_t</a> *ipp<br>
);</p>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Current state</p>
-<h3 class="function"><span class="info"> CUPS 1.1.19 </span><a name="ippWriteFile">ippWriteFile</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.1.19
/Mac OS X 10.3 </span><a name="ippWriteFile">ippWriteFile</a></h3>
<p class="description">Write data for an IPP message to a file.</p>
<p class="code">
-ipp_state_t ippWriteFile (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippWriteFile (<br>
int fd,<br>
<a href="#ipp_t">ipp_t</a> *ipp<br>
);</p>
</dl>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Current state</p>
-<h3 class="function"><span class="info"> CUPS 1.2 </span><a name="ippWriteIO">ippWriteIO</a></h3>
+<h3 class="function"><span class="info"> CUPS 1.2
/Mac OS X 10.5 </span><a name="ippWriteIO">ippWriteIO</a></h3>
<p class="description">Write data for an IPP message.</p>
<p class="code">
-ipp_state_t ippWriteIO (<br>
+<a href="#ipp_state_t">ipp_state_t</a> ippWriteIO (<br>
void *dst,<br>
<a href="#ipp_iocb_t">ipp_iocb_t</a> cb,<br>
int blocking,<br>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Current state</p>
<h2 class="title"><a name="TYPES">Data Types</a></h2>
-<h3 class="typedef"><span class="info"> CUPS 1.2 </span><a name="http_addrlist_t">http_addrlist_t</a></h3>
+<h3 class="typedef"><a name="gss_auth_identity_desc">gss_auth_identity_desc</a></h3>
+<p class="description">Local functions...</p>
+<p class="code">
+typedef struct <a href="#gss_auth_identity">gss_auth_identity</a> gss_auth_identity_desc;
+</p>
+<h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="http_addr_t">http_addr_t</a></h3>
+<p class="description">Socket address union, which
+makes using IPv6 and other
+address types easier and
+more portable. </p>
+<p class="code">
+typedef union _http_addr_u / http_addr_t;
+</p>
+<h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="http_addrlist_t">http_addrlist_t</a></h3>
<p class="description">Socket address list, which is
used to enumerate all of the
addresses that are associated
<p class="code">
typedef enum <a href="#http_auth_e">http_auth_e</a> http_auth_t;
</p>
+<h3 class="typedef"><span class="info"> CUPS 1.5 </span><a name="http_credential_t">http_credential_t</a></h3>
+<p class="description">Credential data </p>
+<p class="code">
+typedef struct <a href="#http_credential_s">http_credential_s</a> http_credential_t;
+</p>
<h3 class="typedef"><a name="http_encoding_t">http_encoding_t</a></h3>
<p class="description">HTTP transfer encoding values</p>
<p class="code">
<p class="code">
typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t;
</p>
+<h3 class="typedef"><a name="http_field_t">http_field_t</a></h3>
+<p class="description">HTTP field names</p>
+<p class="code">
+typedef enum <a href="#http_field_e">http_field_e</a> http_field_t;
+</p>
+<h3 class="typedef"><a name="http_keepalive_t">http_keepalive_t</a></h3>
+<p class="description">HTTP keep-alive values</p>
+<p class="code">
+typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t;
+</p>
+<h3 class="typedef"><a name="http_state_t">http_state_t</a></h3>
+<p class="description">HTTP state values; states
+are server-oriented...</p>
+<p class="code">
+typedef enum <a href="#http_state_e">http_state_e</a> / http_state_t;
+</p>
+<h3 class="typedef"><a name="http_status_t">http_status_t</a></h3>
+<p class="description">HTTP status codes</p>
+<p class="code">
+typedef enum <a href="#http_status_e">http_status_e</a> http_status_t;
+</p>
<h3 class="typedef"><a name="http_t">http_t</a></h3>
<p class="description">HTTP connection type</p>
<p class="code">
typedef struct _http_s http_t;
</p>
+<h3 class="typedef"><a name="http_uri_coding_t">http_uri_coding_t</a></h3>
+<p class="description">URI en/decode flags</p>
+<p class="code">
+typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t;
+</p>
+<h3 class="typedef"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_t">http_uri_status_t</a></h3>
+<p class="description">URI separation status </p>
+<p class="code">
+typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t;
+</p>
+<h3 class="typedef"><a name="http_version_t">http_version_t</a></h3>
+<p class="description">HTTP version numbers</p>
+<p class="code">
+typedef enum <a href="#http_version_e">http_version_e</a> http_version_t;
+</p>
<h3 class="typedef"><a name="ipp_attribute_t">ipp_attribute_t</a></h3>
<p class="description">Attribute</p>
<p class="code">
typedef struct <a href="#ipp_attribute_s">ipp_attribute_s</a> ipp_attribute_t;
</p>
-<h3 class="typedef"><span class="info"> CUPS 1.2 </span><a name="ipp_iocb_t">ipp_iocb_t</a></h3>
+<h3 class="typedef"><a name="ipp_finish_t">ipp_finish_t</a></h3>
+<p class="description">Finishings</p>
+<p class="code">
+typedef enum <a href="#ipp_finish_e">ipp_finish_e</a> ipp_finish_t;
+</p>
+<h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ipp_iocb_t">ipp_iocb_t</a></h3>
<p class="description">IPP IO Callback Function </p>
<p class="code">
typedef ssize_t (*ipp_iocb_t)(void *, <a href="#ipp_uchar_t">ipp_uchar_t</a> *, size_t);
</p>
+<h3 class="typedef"><a name="ipp_jstate_t">ipp_jstate_t</a></h3>
+<p class="description">Job states</p>
+<p class="code">
+typedef enum <a href="#ipp_jstate_e">ipp_jstate_e</a> ipp_jstate_t;
+</p>
+<h3 class="typedef"><a name="ipp_op_t">ipp_op_t</a></h3>
+<p class="description">IPP operations</p>
+<p class="code">
+typedef enum <a href="#ipp_op_e">ipp_op_e</a> ipp_op_t;
+</p>
+<h3 class="typedef"><a name="ipp_orient_t">ipp_orient_t</a></h3>
+<p class="description">Orientation values</p>
+<p class="code">
+typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t;
+</p>
+<h3 class="typedef"><a name="ipp_pstate_t">ipp_pstate_t</a></h3>
+<p class="description">Printer states</p>
+<p class="code">
+typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t;
+</p>
+<h3 class="typedef"><a name="ipp_quality_t">ipp_quality_t</a></h3>
+<p class="description">Qualities</p>
+<p class="code">
+typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t;
+</p>
<h3 class="typedef"><a name="ipp_request_t">ipp_request_t</a></h3>
<p class="description">Request Header</p>
<p class="code">
typedef union <a href="#ipp_request_u">ipp_request_u</a> ipp_request_t;
</p>
+<h3 class="typedef"><a name="ipp_res_t">ipp_res_t</a></h3>
+<p class="description">Resolution units</p>
+<p class="code">
+typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t;
+</p>
+<h3 class="typedef"><a name="ipp_state_t">ipp_state_t</a></h3>
+<p class="description">IPP states</p>
+<p class="code">
+typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t;
+</p>
<h3 class="typedef"><a name="ipp_t">ipp_t</a></h3>
<p class="description">Attribute Value</p>
<p class="code">
typedef struct <a href="#ipp_s">ipp_s</a> ipp_t;
</p>
<h3 class="typedef"><a name="ipp_uchar_t">ipp_uchar_t</a></h3>
-<p class="description">IPP status codes...</p>
+<p class="description">IPP status codes</p>
<p class="code">
typedef typedef unsigned char ipp_uchar_t;
</p>
+<h3 class="typedef"><a name="ipp_tag_t">ipp_tag_t</a></h3>
+<p class="description">Format tags for attributes</p>
+<p class="code">
+typedef enum <a href="#ipp_tag_e">ipp_tag_e</a> ipp_tag_t;
+</p>
<h3 class="typedef"><a name="ipp_value_t">ipp_value_t</a></h3>
-<p class="description">New in CUPS 1.1.19</p>
+<p class="description">Attribute Value</p>
<p class="code">
typedef union <a href="#ipp_value_u">ipp_value_u</a> ipp_value_t;
</p>
<h2 class="title"><a name="STRUCTURES">Structures</a></h2>
-<h3 class="struct"><span class="info"> CUPS 1.2 </span><a name="http_addrlist_s">http_addrlist_s</a></h3>
+<h3 class="struct"><a name="gss_auth_identity">gss_auth_identity</a></h3>
+<p class="description">Local functions...</p>
+<p class="code">struct gss_auth_identity {<br>
+ gss_buffer_t *credentialsRef;<br>
+ uint32_t flags;<br>
+ char *password;<br>
+ char *realm;<br>
+ uint32_t type;<br>
+ char *username;<br>
+};</p>
+<h4 class="members">Members</h4>
+<dl>
+<dt>credentialsRef </dt>
+<dt>flags </dt>
+<dt>password </dt>
+<dt>realm </dt>
+<dt>type </dt>
+<dt>username </dt>
+</dl>
+<h3 class="struct"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="http_addrlist_s">http_addrlist_s</a></h3>
<p class="description">Socket address list, which is
used to enumerate all of the
addresses that are associated
<dt>next </dt>
<dd class="description">Pointer to next address in list</dd>
</dl>
+<h3 class="struct"><span class="info"> CUPS 1.5 </span><a name="http_credential_s">http_credential_s</a></h3>
+<p class="description">Credential data </p>
+<p class="code">struct http_credential_s {<br>
+ void *data;<br>
+ size_t datalen;<br>
+};</p>
+<h4 class="members">Members</h4>
+<dl>
+<dt>data </dt>
+<dd class="description">Pointer to credential data</dd>
+<dt>datalen </dt>
+<dd class="description">Credential length</dd>
+</dl>
<h3 class="struct"><a name="ipp_attribute_s">ipp_attribute_s</a></h3>
<p class="description">Attribute</p>
<p class="code">struct ipp_attribute_s {<br>
char *name;<br>
struct <a href="#ipp_attribute_s">ipp_attribute_s</a> *next;<br>
int num_values;<br>
- ipp_tag_t group_tag, value_tag;<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> group_tag, value_tag;<br>
<a href="#ipp_value_t">ipp_value_t</a> values[1];<br>
};</p>
<h4 class="members">Members</h4>
<p class="code">struct ipp_s {<br>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *attrs;<br>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *current;<br>
- ipp_tag_t curtag;<br>
+ <a href="#ipp_tag_t">ipp_tag_t</a> curtag;<br>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *last;<br>
<a href="#ipp_attribute_t">ipp_attribute_t</a> *prev;<br>
<a href="#ipp_request_t">ipp_request_t</a> request;<br>
- ipp_state_t state;<br>
+ <a href="#ipp_state_t">ipp_state_t</a> state;<br>
+ int use;<br>
};</p>
<h4 class="members">Members</h4>
<dl>
<dd class="description">Current attribute group tag</dd>
<dt>last </dt>
<dd class="description">Last attribute in list</dd>
-<dt>prev </dt>
-<dd class="description">Previous attribute (for read)</dd>
+<dt>prev <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
+<dd class="description">Previous attribute (for read) </dd>
<dt>request </dt>
<dd class="description">Request header</dd>
<dt>state </dt>
<dd class="description">State of request</dd>
+<dt>use <span class="info"> CUPS 1.4.4/Mac OS X 10.6.? </span></dt>
+<dd class="description">Use count </dd>
</dl>
<h2 class="title"><a name="UNIONS">Unions</a></h2>
<h3 class="union"><a name="ipp_request_u">ipp_request_u</a></h3>
<dl>
</dl>
<h3 class="union"><a name="ipp_value_u">ipp_value_u</a></h3>
-<p class="description">New in CUPS 1.1.19</p>
+<p class="description">Attribute Value</p>
<p class="code">union ipp_value_u {<br>
char boolean;<br>
<a href="#ipp_t">ipp_t</a> *collection;<br>
<dl>
<dt>boolean </dt>
<dd class="description">Boolean value</dd>
-<dt>collection </dt>
-<dd class="description">Collection value</dd>
+<dt>collection <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt>
+<dd class="description">Collection value </dd>
<dt>date[11] </dt>
<dd class="description">Date/time value</dd>
<dt>integer </dt>
<dd class="description">MD5-session authentication in use</dd>
<dt>HTTP_AUTH_MD5_SESS_INT </dt>
<dd class="description">MD5-session authentication in use for body</dd>
-<dt>HTTP_AUTH_NEGOTIATE <span class="info"> CUPS 1.3 </span></dt>
+<dt>HTTP_AUTH_NEGOTIATE <span class="info"> CUPS 1.3/Mac OS X 10.5 </span></dt>
<dd class="description">GSSAPI authentication in use </dd>
<dt>HTTP_AUTH_NONE </dt>
<dd class="description">No authentication in use</dd>
<dd class="description">WWW-Authenticate field</dd>
</dl>
<h3 class="enumeration"><a name="http_keepalive_e">http_keepalive_e</a></h3>
-<p class="description">Types and structures...</p>
+<p class="description">HTTP keep-alive values</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>HTTP_KEEPALIVE_OFF </dt>
<dd class="description">Use keep alive</dd>
</dl>
<h3 class="enumeration"><a name="http_state_e">http_state_e</a></h3>
-<p class="description"></p>
+<p class="description">HTTP state values; states
+are server-oriented...</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>HTTP_CLOSE </dt>
<dl>
<dt>HTTP_ACCEPTED </dt>
<dd class="description">DELETE command was successful</dd>
+<dt>HTTP_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></dt>
+<dd class="description">User canceled authorization </dd>
<dt>HTTP_BAD_GATEWAY </dt>
<dd class="description">Bad gateway</dd>
<dt>HTTP_BAD_REQUEST </dt>
<dd class="description">Only a partial file was recieved/sent</dd>
<dt>HTTP_PAYMENT_REQUIRED </dt>
<dd class="description">Payment required</dd>
+<dt>HTTP_PKI_ERROR <span class="info"> CUPS 1.5 </span></dt>
+<dd class="description">Error negotiating a secure connection </dd>
<dt>HTTP_PRECONDITION </dt>
<dd class="description">Precondition failed</dd>
<dt>HTTP_PROXY_AUTHENTICATION </dt>
<dd class="description">Must use a proxy to access this URI</dd>
</dl>
<h3 class="enumeration"><a name="http_uri_coding_e">http_uri_coding_e</a></h3>
-<p class="description"></p>
+<p class="description">URI en/decode flags</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>HTTP_URI_CODING_ALL </dt>
<dt>HTTP_URI_CODING_USERNAME </dt>
<dd class="description">En/decode the username portion</dd>
</dl>
-<h3 class="enumeration"><a name="http_uri_status_e">http_uri_status_e</a></h3>
-<p class="description"></p>
+<h3 class="enumeration"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_e">http_uri_status_e</a></h3>
+<p class="description">URI separation status </p>
<h4 class="constants">Constants</h4>
<dl>
<dt>HTTP_URI_BAD_ARGUMENTS </dt>
<dd class="description">Unknown scheme in URI (warning)</dd>
</dl>
<h3 class="enumeration"><a name="http_version_e">http_version_e</a></h3>
-<p class="description"></p>
+<p class="description">HTTP version numbers</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>HTTP_0_9 </dt>
<dd class="description">HTTP/1.1</dd>
</dl>
<h3 class="enumeration"><a name="ipp_finish_e">ipp_finish_e</a></h3>
-<p class="description"></p>
+<p class="description">Finishings</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_FINISHINGS_BALE </dt>
<dd class="description">Trim (any type)</dd>
</dl>
<h3 class="enumeration"><a name="ipp_jstate_e">ipp_jstate_e</a></h3>
-<p class="description"></p>
+<p class="description">Job states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_JOB_ABORTED </dt>
<dd class="description">Job has been stopped</dd>
</dl>
<h3 class="enumeration"><a name="ipp_op_e">ipp_op_e</a></h3>
-<p class="description"></p>
+<p class="description">IPP operations</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>CUPS_ACCEPT_JOBS </dt>
<dd class="description">Add or modify a class</dd>
<dt>CUPS_ADD_MODIFY_PRINTER </dt>
<dd class="description">Add or modify a printer</dd>
-<dt>CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2 </span></dt>
+<dt>CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Authenticate a job </dd>
<dt>CUPS_DELETE_CLASS </dt>
<dd class="description">Delete a class</dd>
<dd class="description">Get the default printer</dd>
<dt>CUPS_GET_DEVICES </dt>
<dd class="description">Get a list of supported devices</dd>
-<dt>CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4 </span></dt>
+<dt>CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/Mac OS X 10.6 </span></dt>
<dd class="description">Get a document file </dd>
-<dt>CUPS_GET_PPD <span class="info"> CUPS 1.3 </span></dt>
+<dt>CUPS_GET_PPD <span class="info"> CUPS 1.3/Mac OS X 10.5 </span></dt>
<dd class="description">Get a PPD file </dd>
<dt>CUPS_GET_PPDS </dt>
<dd class="description">Get a list of supported drivers</dd>
<dd class="description">Set the default printer</dd>
<dt>IPP_CANCEL_JOB </dt>
<dd class="description">Cancel a job</dd>
-<dt>IPP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_CANCEL_JOBS </dt>
+<dd class="description">Cancel-Jobs</dd>
+<dt>IPP_CANCEL_MY_JOBS </dt>
+<dd class="description">Cancel-My-Jobs</dd>
+<dt>IPP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Cancel a subscription </dd>
+<dt>IPP_CLOSE_JOB </dt>
+<dd class="description">Close-Job</dd>
<dt>IPP_CREATE_JOB </dt>
<dd class="description">Create an empty print job</dd>
-<dt>IPP_CREATE_JOB_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_CREATE_JOB_SUBSCRIPTION <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Create a job subscription </dd>
-<dt>IPP_CREATE_PRINTER_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_CREATE_PRINTER_SUBSCRIPTION <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Create a printer subscription </dd>
<dt>IPP_DISABLE_PRINTER </dt>
<dd class="description">Stop a printer</dd>
<dd class="description">Get a list of jobs</dd>
<dt>IPP_GET_JOB_ATTRIBUTES </dt>
<dd class="description">Get job attributes</dd>
-<dt>IPP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Get notification events </dd>
<dt>IPP_GET_PRINTER_ATTRIBUTES </dt>
<dd class="description">Get printer attributes</dd>
<dt>IPP_GET_PRINTER_SUPPORTED_VALUES </dt>
<dd class="description">Get supported attribute values</dd>
-<dt>IPP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Get list of subscriptions </dd>
-<dt>IPP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Get subscription attributes </dd>
<dt>IPP_HOLD_JOB </dt>
<dd class="description">Hold a job for printing</dd>
<dd class="description">Cancel all jobs</dd>
<dt>IPP_RELEASE_JOB </dt>
<dd class="description">Release a job for printing</dd>
-<dt>IPP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></dt>
+<dt>IPP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt>
<dd class="description">Renew a printer subscription </dd>
<dt>IPP_RESTART_JOB </dt>
<dd class="description">Reprint a job</dd>
+<dt>IPP_RESUBMIT_JOB </dt>
+<dd class="description">Resubmit-Job</dd>
<dt>IPP_RESUME_PRINTER </dt>
<dd class="description">Start a printer</dd>
<dt>IPP_SEND_DOCUMENT </dt>
<dd class="description">Validate job options</dd>
</dl>
<h3 class="enumeration"><a name="ipp_orient_e">ipp_orient_e</a></h3>
-<p class="description"></p>
+<p class="description">Orientation values</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_LANDSCAPE </dt>
<dd class="description">180 degrees</dd>
</dl>
<h3 class="enumeration"><a name="ipp_pstate_e">ipp_pstate_e</a></h3>
-<p class="description"></p>
+<p class="description">Printer states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_PRINTER_IDLE </dt>
<dd class="description">Printer is stopped</dd>
</dl>
<h3 class="enumeration"><a name="ipp_quality_e">ipp_quality_e</a></h3>
-<p class="description"></p>
+<p class="description">Qualities</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_QUALITY_DRAFT </dt>
<dd class="description">Normal quality</dd>
</dl>
<h3 class="enumeration"><a name="ipp_res_e">ipp_res_e</a></h3>
-<p class="description">Types and structures...</p>
+<p class="description">Resolution units</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_RES_PER_CM </dt>
<dd class="description">Pixels per inch</dd>
</dl>
<h3 class="enumeration"><a name="ipp_state_e">ipp_state_e</a></h3>
-<p class="description"></p>
+<p class="description">IPP states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_ATTRIBUTE </dt>
<dd class="description">Nothing is happening/request completed</dd>
</dl>
<h3 class="enumeration"><a name="ipp_status_e">ipp_status_e</a></h3>
-<p class="description">IPP status codes...</p>
+<p class="description">IPP status codes</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>CUPS_SEE_OTHER </dt>
<dd class="description">client-error-attributes-or-values-not-supported</dd>
<dt>IPP_ATTRIBUTES_NOT_SETTABLE </dt>
<dd class="description">client-error-attributes-not-settable</dd>
+<dt>IPP_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5 </span></dt>
+<dd class="description">Authentication canceled by user </dd>
<dt>IPP_BAD_REQUEST </dt>
<dd class="description">client-error-bad-request</dd>
<dt>IPP_CHARSET </dt>
<dd class="description">successful-ok-too-many-events</dd>
<dt>IPP_OPERATION_NOT_SUPPORTED </dt>
<dd class="description">server-error-operation-not-supported</dd>
+<dt>IPP_PKI_ERROR <span class="info"> CUPS 1.5 </span></dt>
+<dd class="description">Error negotiating a secure connection </dd>
<dt>IPP_PRINTER_BUSY </dt>
<dd class="description">server-error-busy</dd>
<dt>IPP_PRINTER_IS_DEACTIVATED </dt>
<dd class="description">client-error-timeout</dd>
<dt>IPP_TOO_MANY_SUBSCRIPTIONS </dt>
<dd class="description">client-error-too-many-subscriptions</dd>
+<dt>IPP_UPGRADE_REQUIRED </dt>
+<dd class="description">TLS upgrade required</dd>
<dt>IPP_URI_SCHEME </dt>
<dd class="description">client-error-uri-scheme-not-supported</dd>
<dt>IPP_VERSION_NOT_SUPPORTED </dt>
<dd class="description">server-error-version-not-supported</dd>
</dl>
<h3 class="enumeration"><a name="ipp_tag_e">ipp_tag_e</a></h3>
-<p class="description">Format tags for attributes...</p>
+<p class="description">Format tags for attributes</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_TAG_ADMINDEFINE </dt>
projects / thirdparty / cups.git / blobdiff