| <!DOCTYPE html> |
| <html> |
| <!-- SECTION: Programming --> |
| <head> |
| <title>CUPS Programming Manual</title> |
| <meta name="keywords" content="Programming"> |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> |
| <meta name="creator" content="codedoc v3.1"> |
| <meta name="author" content="Michael R Sweet"> |
| <meta name="copyright" content="Copyright © 2007-2019 by Apple Inc. All Rights Reserved."> |
| <meta name="version" content="2.3.3"> |
| <style type="text/css"><!-- |
| body, p, h1, h2, h3, h4 { |
| font-family: sans-serif; |
| } |
| div.body h1 { |
| font-size: 250%; |
| font-weight: bold; |
| margin: 0; |
| } |
| div.body h2 { |
| font-size: 250%; |
| margin-top: 1.5em; |
| } |
| div.body h3 { |
| font-size: 150%; |
| margin-bottom: 0.5em; |
| margin-top: 1.5em; |
| } |
| div.body h4 { |
| font-size: 110%; |
| margin-bottom: 0.5em; |
| margin-top: 1.5em; |
| } |
| div.body h5 { |
| font-size: 100%; |
| margin-bottom: 0.5em; |
| margin-top: 1.5em; |
| } |
| div.contents { |
| background: #e8e8e8; |
| border: solid thin black; |
| padding: 10px; |
| } |
| div.contents h1 { |
| font-size: 110%; |
| } |
| div.contents h2 { |
| font-size: 100%; |
| } |
| div.contents ul.contents { |
| font-size: 80%; |
| } |
| .class { |
| border-bottom: solid 2px gray; |
| } |
| .constants { |
| } |
| .description { |
| margin-top: 0.5em; |
| } |
| .discussion { |
| } |
| .enumeration { |
| border-bottom: solid 2px gray; |
| } |
| .function { |
| border-bottom: solid 2px gray; |
| margin-bottom: 0; |
| } |
| .members { |
| } |
| .method { |
| } |
| .parameters { |
| } |
| .returnvalue { |
| } |
| .struct { |
| border-bottom: solid 2px gray; |
| } |
| .typedef { |
| border-bottom: solid 2px gray; |
| } |
| .union { |
| border-bottom: solid 2px gray; |
| } |
| .variable { |
| } |
| h1, h2, h3, h4, h5, h6 { |
| page-break-inside: avoid; |
| } |
| blockquote { |
| border: solid thin gray; |
| box-shadow: 3px 3px 5px rgba(0,0,0,0.5); |
| padding: 0px 10px; |
| page-break-inside: avoid; |
| } |
| p code, li code, p.code, pre, ul.code li { |
| background: rgba(127,127,127,0.1); |
| border: thin dotted gray; |
| font-family: monospace; |
| font-size: 90%; |
| hyphens: manual; |
| -webkit-hyphens: manual; |
| page-break-inside: avoid; |
| } |
| p.code, pre, ul.code li { |
| padding: 10px; |
| } |
| p code, li code { |
| padding: 2px 5px; |
| } |
| a:link, a:visited { |
| text-decoration: none; |
| } |
| span.info { |
| background: black; |
| border: solid thin black; |
| color: white; |
| font-size: 80%; |
| font-style: italic; |
| font-weight: bold; |
| white-space: nowrap; |
| } |
| h3 span.info, h4 span.info { |
| border-top-left-radius: 10px; |
| border-top-right-radius: 10px; |
| float: right; |
| padding: 3px 6px; |
| } |
| ul.code, ul.contents, ul.subcontents { |
| list-style-type: none; |
| margin: 0; |
| padding-left: 0; |
| } |
| ul.code li { |
| margin: 0; |
| } |
| ul.contents > li { |
| margin-top: 1em; |
| } |
| ul.contents li ul.code, ul.contents li ul.subcontents { |
| padding-left: 2em; |
| } |
| table.list { |
| border-collapse: collapse; |
| width: 100%; |
| } |
| table.list tr:nth-child(even) { |
| background: rgba(127,127,127,0.1);]n} |
| table.list th { |
| border-right: 2px solid gray; |
| font-family: monospace; |
| padding: 5px 10px 5px 2px; |
| text-align: right; |
| vertical-align: top; |
| } |
| table.list td { |
| padding: 5px 2px 5px 10px; |
| text-align: left; |
| vertical-align: top; |
| } |
| h1.title { |
| } |
| h2.title { |
| border-bottom: solid 2px black; |
| } |
| h3.title { |
| border-bottom: solid 2px black; |
| } |
| --></style> |
| </head> |
| <body> |
| <h1 class="title">CUPS Programming Manual</h1> |
| <p>Michael R Sweet</p> |
| <p>Copyright © 2007-2019 by Apple Inc. All Rights Reserved.</p> |
| <div class="contents"> |
| <h2 class="title">Contents</h2> |
| <ul class="contents"> |
| <li><a href="#introduction">Introduction</a><ul class="subcontents"> |
| <li><a href="#guidelines">Guidelines</a></li> |
| <li><a href="#terms-used-in-this-document">Terms Used in This Document</a></li> |
| <li><a href="#compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></li> |
| </ul></li> |
| <li><a href="#working-with-destinations">Working with Destinations</a><ul class="subcontents"> |
| <li><a href="#finding-available-destinations">Finding Available Destinations</a></li> |
| <li><a href="#basic-destination-information">Basic Destination Information</a></li> |
| <li><a href="#detailed-destination-information">Detailed Destination Information</a></li> |
| <li><a href="#submitting-a-print-job">Submitting a Print Job</a></li> |
| </ul></li> |
| <li><a href="#sending-ipp-requests">Sending IPP Requests</a><ul class="subcontents"> |
| <li><a href="#connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></li> |
| <li><a href="#creating-an-ipp-request">Creating an IPP Request</a></li> |
| <li><a href="#sending-the-ipp-request">Sending the IPP Request</a></li> |
| <li><a href="#processing-the-ipp-response">Processing the IPP Response</a></li> |
| <li><a href="#authentication">Authentication</a></li> |
| </ul></li> |
| <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> |
| <li><a href="#cupsAddDest">cupsAddDest</a></li> |
| <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li> |
| <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li> |
| <li><a href="#cupsAddOption">cupsAddOption</a></li> |
| <li><a href="#cupsCancelDestJob">cupsCancelDestJob</a></li> |
| <li><a href="#cupsCheckDestSupported">cupsCheckDestSupported</a></li> |
| <li><a href="#cupsCloseDestJob">cupsCloseDestJob</a></li> |
| <li><a href="#cupsConnectDest">cupsConnectDest</a></li> |
| <li><a href="#cupsCopyDest">cupsCopyDest</a></li> |
| <li><a href="#cupsCopyDestConflicts">cupsCopyDestConflicts</a></li> |
| <li><a href="#cupsCopyDestInfo">cupsCopyDestInfo</a></li> |
| <li><a href="#cupsCreateDestJob">cupsCreateDestJob</a></li> |
| <li><a href="#cupsDoAuthentication">cupsDoAuthentication</a></li> |
| <li><a href="#cupsEncodeOption">cupsEncodeOption</a></li> |
| <li><a href="#cupsEncodeOptions">cupsEncodeOptions</a></li> |
| <li><a href="#cupsEncodeOptions2">cupsEncodeOptions2</a></li> |
| <li><a href="#cupsEncryption">cupsEncryption</a></li> |
| <li><a href="#cupsEnumDests">cupsEnumDests</a></li> |
| <li><a href="#cupsFindDestDefault">cupsFindDestDefault</a></li> |
| <li><a href="#cupsFindDestReady">cupsFindDestReady</a></li> |
| <li><a href="#cupsFindDestSupported">cupsFindDestSupported</a></li> |
| <li><a href="#cupsFinishDestDocument">cupsFinishDestDocument</a></li> |
| <li><a href="#cupsFreeDestInfo">cupsFreeDestInfo</a></li> |
| <li><a href="#cupsFreeDests">cupsFreeDests</a></li> |
| <li><a href="#cupsFreeJobs">cupsFreeJobs</a></li> |
| <li><a href="#cupsFreeOptions">cupsFreeOptions</a></li> |
| <li><a href="#cupsGetDest">cupsGetDest</a></li> |
| <li><a href="#cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></li> |
| <li><a href="#cupsGetDestMediaByName">cupsGetDestMediaByName</a></li> |
| <li><a href="#cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></li> |
| <li><a href="#cupsGetDestMediaCount">cupsGetDestMediaCount</a></li> |
| <li><a href="#cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></li> |
| <li><a href="#cupsGetDestWithURI">cupsGetDestWithURI</a></li> |
| <li><a href="#cupsGetDests2">cupsGetDests2</a></li> |
| <li><a href="#cupsGetIntegerOption">cupsGetIntegerOption</a></li> |
| <li><a href="#cupsGetJobs2">cupsGetJobs2</a></li> |
| <li><a href="#cupsGetNamedDest">cupsGetNamedDest</a></li> |
| <li><a href="#cupsGetOption">cupsGetOption</a></li> |
| <li><a href="#cupsGetPassword2">cupsGetPassword2</a></li> |
| <li><a href="#cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></li> |
| <li><a href="#cupsLocalizeDestOption">cupsLocalizeDestOption</a></li> |
| <li><a href="#cupsLocalizeDestValue">cupsLocalizeDestValue</a></li> |
| <li><a href="#cupsMakeServerCredentials">cupsMakeServerCredentials</a></li> |
| <li><a href="#cupsParseOptions">cupsParseOptions</a></li> |
| <li><a href="#cupsRemoveDest">cupsRemoveDest</a></li> |
| <li><a href="#cupsRemoveOption">cupsRemoveOption</a></li> |
| <li><a href="#cupsServer">cupsServer</a></li> |
| <li><a href="#cupsSetClientCertCB">cupsSetClientCertCB</a></li> |
| <li><a href="#cupsSetCredentials">cupsSetCredentials</a></li> |
| <li><a href="#cupsSetDefaultDest">cupsSetDefaultDest</a></li> |
| <li><a href="#cupsSetDests2">cupsSetDests2</a></li> |
| <li><a href="#cupsSetEncryption">cupsSetEncryption</a></li> |
| <li><a href="#cupsSetPasswordCB2">cupsSetPasswordCB2</a></li> |
| <li><a href="#cupsSetServer">cupsSetServer</a></li> |
| <li><a href="#cupsSetServerCertCB">cupsSetServerCertCB</a></li> |
| <li><a href="#cupsSetServerCredentials">cupsSetServerCredentials</a></li> |
| <li><a href="#cupsSetUser">cupsSetUser</a></li> |
| <li><a href="#cupsSetUserAgent">cupsSetUserAgent</a></li> |
| <li><a href="#cupsStartDestDocument">cupsStartDestDocument</a></li> |
| <li><a href="#cupsUser">cupsUser</a></li> |
| <li><a href="#cupsUserAgent">cupsUserAgent</a></li> |
| <li><a href="#httpAcceptConnection">httpAcceptConnection</a></li> |
| <li><a href="#httpAddCredential">httpAddCredential</a></li> |
| <li><a href="#httpAddrAny">httpAddrAny</a></li> |
| <li><a href="#httpAddrClose">httpAddrClose</a></li> |
| <li><a href="#httpAddrConnect2">httpAddrConnect2</a></li> |
| <li><a href="#httpAddrCopyList">httpAddrCopyList</a></li> |
| <li><a href="#httpAddrEqual">httpAddrEqual</a></li> |
| <li><a href="#httpAddrFamily">httpAddrFamily</a></li> |
| <li><a href="#httpAddrFreeList">httpAddrFreeList</a></li> |
| <li><a href="#httpAddrGetList">httpAddrGetList</a></li> |
| <li><a href="#httpAddrLength">httpAddrLength</a></li> |
| <li><a href="#httpAddrListen">httpAddrListen</a></li> |
| <li><a href="#httpAddrLocalhost">httpAddrLocalhost</a></li> |
| <li><a href="#httpAddrLookup">httpAddrLookup</a></li> |
| <li><a href="#httpAddrPort">httpAddrPort</a></li> |
| <li><a href="#httpAddrString">httpAddrString</a></li> |
| <li><a href="#httpAssembleURI">httpAssembleURI</a></li> |
| <li><a href="#httpAssembleURIf">httpAssembleURIf</a></li> |
| <li><a href="#httpAssembleUUID">httpAssembleUUID</a></li> |
| <li><a href="#httpBlocking">httpBlocking</a></li> |
| <li><a href="#httpCheck">httpCheck</a></li> |
| <li><a href="#httpClearCookie">httpClearCookie</a></li> |
| <li><a href="#httpClearFields">httpClearFields</a></li> |
| <li><a href="#httpClose">httpClose</a></li> |
| <li><a href="#httpCompareCredentials">httpCompareCredentials</a></li> |
| <li><a href="#httpConnect2">httpConnect2</a></li> |
| <li><a href="#httpCopyCredentials">httpCopyCredentials</a></li> |
| <li><a href="#httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></li> |
| <li><a href="#httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></li> |
| <li><a href="#httpCredentialsGetTrust">httpCredentialsGetTrust</a></li> |
| <li><a href="#httpCredentialsString">httpCredentialsString</a></li> |
| <li><a href="#httpDecode64_2">httpDecode64_2</a></li> |
| <li><a href="#httpDelete">httpDelete</a></li> |
| <li><a href="#httpEncode64_2">httpEncode64_2</a></li> |
| <li><a href="#httpEncryption">httpEncryption</a></li> |
| <li><a href="#httpError">httpError</a></li> |
| <li><a href="#httpFieldValue">httpFieldValue</a></li> |
| <li><a href="#httpFlush">httpFlush</a></li> |
| <li><a href="#httpFlushWrite">httpFlushWrite</a></li> |
| <li><a href="#httpFreeCredentials">httpFreeCredentials</a></li> |
| <li><a href="#httpGet">httpGet</a></li> |
| <li><a href="#httpGetActivity">httpGetActivity</a></li> |
| <li><a href="#httpGetAddress">httpGetAddress</a></li> |
| <li><a href="#httpGetAuthString">httpGetAuthString</a></li> |
| <li><a href="#httpGetBlocking">httpGetBlocking</a></li> |
| <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li> |
| <li><a href="#httpGetCookie">httpGetCookie</a></li> |
| <li><a href="#httpGetDateString2">httpGetDateString2</a></li> |
| <li><a href="#httpGetDateTime">httpGetDateTime</a></li> |
| <li><a href="#httpGetEncryption">httpGetEncryption</a></li> |
| <li><a href="#httpGetExpect">httpGetExpect</a></li> |
| <li><a href="#httpGetFd">httpGetFd</a></li> |
| <li><a href="#httpGetField">httpGetField</a></li> |
| <li><a href="#httpGetHostname">httpGetHostname</a></li> |
| <li><a href="#httpGetKeepAlive">httpGetKeepAlive</a></li> |
| <li><a href="#httpGetLength2">httpGetLength2</a></li> |
| <li><a href="#httpGetPending">httpGetPending</a></li> |
| <li><a href="#httpGetReady">httpGetReady</a></li> |
| <li><a href="#httpGetRemaining">httpGetRemaining</a></li> |
| <li><a href="#httpGetState">httpGetState</a></li> |
| <li><a href="#httpGetStatus">httpGetStatus</a></li> |
| <li><a href="#httpGetSubField2">httpGetSubField2</a></li> |
| <li><a href="#httpGetVersion">httpGetVersion</a></li> |
| <li><a href="#httpGets">httpGets</a></li> |
| <li><a href="#httpHead">httpHead</a></li> |
| <li><a href="#httpInitialize">httpInitialize</a></li> |
| <li><a href="#httpIsChunked">httpIsChunked</a></li> |
| <li><a href="#httpIsEncrypted">httpIsEncrypted</a></li> |
| <li><a href="#httpLoadCredentials">httpLoadCredentials</a></li> |
| <li><a href="#httpOptions">httpOptions</a></li> |
| <li><a href="#httpPeek">httpPeek</a></li> |
| <li><a href="#httpPost">httpPost</a></li> |
| <li><a href="#httpPut">httpPut</a></li> |
| <li><a href="#httpRead2">httpRead2</a></li> |
| <li><a href="#httpReadRequest">httpReadRequest</a></li> |
| <li><a href="#httpReconnect2">httpReconnect2</a></li> |
| <li><a href="#httpResolveHostname">httpResolveHostname</a></li> |
| <li><a href="#httpSaveCredentials">httpSaveCredentials</a></li> |
| <li><a href="#httpSeparateURI">httpSeparateURI</a></li> |
| <li><a href="#httpSetAuthString">httpSetAuthString</a></li> |
| <li><a href="#httpSetCookie">httpSetCookie</a></li> |
| <li><a href="#httpSetCredentials">httpSetCredentials</a></li> |
| <li><a href="#httpSetDefaultField">httpSetDefaultField</a></li> |
| <li><a href="#httpSetExpect">httpSetExpect</a></li> |
| <li><a href="#httpSetField">httpSetField</a></li> |
| <li><a href="#httpSetKeepAlive">httpSetKeepAlive</a></li> |
| <li><a href="#httpSetLength">httpSetLength</a></li> |
| <li><a href="#httpSetTimeout">httpSetTimeout</a></li> |
| <li><a href="#httpShutdown">httpShutdown</a></li> |
| <li><a href="#httpStateString">httpStateString</a></li> |
| <li><a href="#httpStatus">httpStatus</a></li> |
| <li><a href="#httpURIStatusString">httpURIStatusString</a></li> |
| <li><a href="#httpUpdate">httpUpdate</a></li> |
| <li><a href="#httpWait">httpWait</a></li> |
| <li><a href="#httpWrite2">httpWrite2</a></li> |
| <li><a href="#httpWriteResponse">httpWriteResponse</a></li> |
| <li><a href="#ippAddBoolean">ippAddBoolean</a></li> |
| <li><a href="#ippAddBooleans">ippAddBooleans</a></li> |
| <li><a href="#ippAddCollection">ippAddCollection</a></li> |
| <li><a href="#ippAddCollections">ippAddCollections</a></li> |
| <li><a href="#ippAddDate">ippAddDate</a></li> |
| <li><a href="#ippAddInteger">ippAddInteger</a></li> |
| <li><a href="#ippAddIntegers">ippAddIntegers</a></li> |
| <li><a href="#ippAddOctetString">ippAddOctetString</a></li> |
| <li><a href="#ippAddOutOfBand">ippAddOutOfBand</a></li> |
| <li><a href="#ippAddRange">ippAddRange</a></li> |
| <li><a href="#ippAddRanges">ippAddRanges</a></li> |
| <li><a href="#ippAddResolution">ippAddResolution</a></li> |
| <li><a href="#ippAddResolutions">ippAddResolutions</a></li> |
| <li><a href="#ippAddSeparator">ippAddSeparator</a></li> |
| <li><a href="#ippAddString">ippAddString</a></li> |
| <li><a href="#ippAddStringf">ippAddStringf</a></li> |
| <li><a href="#ippAddStringfv">ippAddStringfv</a></li> |
| <li><a href="#ippAddStrings">ippAddStrings</a></li> |
| <li><a href="#ippAttributeString">ippAttributeString</a></li> |
| <li><a href="#ippContainsInteger">ippContainsInteger</a></li> |
| <li><a href="#ippContainsString">ippContainsString</a></li> |
| <li><a href="#ippCopyAttribute">ippCopyAttribute</a></li> |
| <li><a href="#ippCopyAttributes">ippCopyAttributes</a></li> |
| <li><a href="#ippCreateRequestedArray">ippCreateRequestedArray</a></li> |
| <li><a href="#ippDateToTime">ippDateToTime</a></li> |
| <li><a href="#ippDelete">ippDelete</a></li> |
| <li><a href="#ippDeleteAttribute">ippDeleteAttribute</a></li> |
| <li><a href="#ippDeleteValues">ippDeleteValues</a></li> |
| <li><a href="#ippEnumString">ippEnumString</a></li> |
| <li><a href="#ippEnumValue">ippEnumValue</a></li> |
| <li><a href="#ippErrorString">ippErrorString</a></li> |
| <li><a href="#ippErrorValue">ippErrorValue</a></li> |
| <li><a href="#ippFindAttribute">ippFindAttribute</a></li> |
| <li><a href="#ippFindNextAttribute">ippFindNextAttribute</a></li> |
| <li><a href="#ippFirstAttribute">ippFirstAttribute</a></li> |
| <li><a href="#ippGetBoolean">ippGetBoolean</a></li> |
| <li><a href="#ippGetCollection">ippGetCollection</a></li> |
| <li><a href="#ippGetCount">ippGetCount</a></li> |
| <li><a href="#ippGetDate">ippGetDate</a></li> |
| <li><a href="#ippGetGroupTag">ippGetGroupTag</a></li> |
| <li><a href="#ippGetInteger">ippGetInteger</a></li> |
| <li><a href="#ippGetName">ippGetName</a></li> |
| <li><a href="#ippGetOctetString">ippGetOctetString</a></li> |
| <li><a href="#ippGetOperation">ippGetOperation</a></li> |
| <li><a href="#ippGetRange">ippGetRange</a></li> |
| <li><a href="#ippGetRequestId">ippGetRequestId</a></li> |
| <li><a href="#ippGetResolution">ippGetResolution</a></li> |
| <li><a href="#ippGetState">ippGetState</a></li> |
| <li><a href="#ippGetStatusCode">ippGetStatusCode</a></li> |
| <li><a href="#ippGetString">ippGetString</a></li> |
| <li><a href="#ippGetValueTag">ippGetValueTag</a></li> |
| <li><a href="#ippGetVersion">ippGetVersion</a></li> |
| <li><a href="#ippLength">ippLength</a></li> |
| <li><a href="#ippNew">ippNew</a></li> |
| <li><a href="#ippNewRequest">ippNewRequest</a></li> |
| <li><a href="#ippNewResponse">ippNewResponse</a></li> |
| <li><a href="#ippNextAttribute">ippNextAttribute</a></li> |
| <li><a href="#ippOpString">ippOpString</a></li> |
| <li><a href="#ippOpValue">ippOpValue</a></li> |
| <li><a href="#ippPort">ippPort</a></li> |
| <li><a href="#ippRead">ippRead</a></li> |
| <li><a href="#ippReadFile">ippReadFile</a></li> |
| <li><a href="#ippReadIO">ippReadIO</a></li> |
| <li><a href="#ippSetBoolean">ippSetBoolean</a></li> |
| <li><a href="#ippSetCollection">ippSetCollection</a></li> |
| <li><a href="#ippSetDate">ippSetDate</a></li> |
| <li><a href="#ippSetGroupTag">ippSetGroupTag</a></li> |
| <li><a href="#ippSetInteger">ippSetInteger</a></li> |
| <li><a href="#ippSetName">ippSetName</a></li> |
| <li><a href="#ippSetOctetString">ippSetOctetString</a></li> |
| <li><a href="#ippSetOperation">ippSetOperation</a></li> |
| <li><a href="#ippSetPort">ippSetPort</a></li> |
| <li><a href="#ippSetRange">ippSetRange</a></li> |
| <li><a href="#ippSetRequestId">ippSetRequestId</a></li> |
| <li><a href="#ippSetResolution">ippSetResolution</a></li> |
| <li><a href="#ippSetState">ippSetState</a></li> |
| <li><a href="#ippSetStatusCode">ippSetStatusCode</a></li> |
| <li><a href="#ippSetString">ippSetString</a></li> |
| <li><a href="#ippSetStringf">ippSetStringf</a></li> |
| <li><a href="#ippSetStringfv">ippSetStringfv</a></li> |
| <li><a href="#ippSetValueTag">ippSetValueTag</a></li> |
| <li><a href="#ippSetVersion">ippSetVersion</a></li> |
| <li><a href="#ippStateString">ippStateString</a></li> |
| <li><a href="#ippTagString">ippTagString</a></li> |
| <li><a href="#ippTagValue">ippTagValue</a></li> |
| <li><a href="#ippTimeToDate">ippTimeToDate</a></li> |
| <li><a href="#ippValidateAttribute">ippValidateAttribute</a></li> |
| <li><a href="#ippValidateAttributes">ippValidateAttributes</a></li> |
| <li><a href="#ippWrite">ippWrite</a></li> |
| <li><a href="#ippWriteFile">ippWriteFile</a></li> |
| <li><a href="#ippWriteIO">ippWriteIO</a></li> |
| </ul></li> |
| <li><a href="#TYPES">Data Types</a><ul class="subcontents"> |
| <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li> |
| <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li> |
| <li><a href="#cups_dest_t">cups_dest_t</a></li> |
| <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li> |
| <li><a href="#cups_job_t">cups_job_t</a></li> |
| <li><a href="#cups_option_t">cups_option_t</a></li> |
| <li><a href="#cups_password_cb2_t">cups_password_cb2_t</a></li> |
| <li><a href="#cups_ptype_t">cups_ptype_t</a></li> |
| <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li> |
| <li><a href="#cups_size_t">cups_size_t</a></li> |
| <li><a href="#http_addr_t">http_addr_t</a></li> |
| <li><a href="#http_encoding_t">http_encoding_t</a></li> |
| <li><a href="#http_encryption_t">http_encryption_t</a></li> |
| <li><a href="#http_field_t">http_field_t</a></li> |
| <li><a href="#http_keepalive_t">http_keepalive_t</a></li> |
| <li><a href="#http_state_t">http_state_t</a></li> |
| <li><a href="#http_t">http_t</a></li> |
| <li><a href="#http_timeout_cb_t">http_timeout_cb_t</a></li> |
| <li><a href="#http_trust_t">http_trust_t</a></li> |
| <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li> |
| <li><a href="#http_uri_status_t">http_uri_status_t</a></li> |
| <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li> |
| <li><a href="#ipp_copycb_t">ipp_copycb_t</a></li> |
| <li><a href="#ipp_iocb_t">ipp_iocb_t</a></li> |
| <li><a href="#ipp_orient_t">ipp_orient_t</a></li> |
| <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li> |
| <li><a href="#ipp_quality_t">ipp_quality_t</a></li> |
| <li><a href="#ipp_res_t">ipp_res_t</a></li> |
| <li><a href="#ipp_rstate_t">ipp_rstate_t</a></li> |
| <li><a href="#ipp_sstate_t">ipp_sstate_t</a></li> |
| <li><a href="#ipp_state_t">ipp_state_t</a></li> |
| <li><a href="#ipp_t">ipp_t</a></li> |
| </ul></li> |
| <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> |
| <li><a href="#cups_dest_s">cups_dest_s</a></li> |
| <li><a href="#cups_job_s">cups_job_s</a></li> |
| <li><a href="#cups_option_s">cups_option_s</a></li> |
| <li><a href="#cups_size_s">cups_size_s</a></li> |
| </ul></li> |
| <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> |
| <li><a href="#cups_ptype_e">cups_ptype_e</a></li> |
| <li><a href="#http_encoding_e">http_encoding_e</a></li> |
| <li><a href="#http_encryption_e">http_encryption_e</a></li> |
| <li><a href="#http_field_e">http_field_e</a></li> |
| <li><a href="#http_keepalive_e">http_keepalive_e</a></li> |
| <li><a href="#http_state_e">http_state_e</a></li> |
| <li><a href="#http_status_e">http_status_e</a></li> |
| <li><a href="#http_trust_e">http_trust_e</a></li> |
| <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li> |
| <li><a href="#http_uri_status_e">http_uri_status_e</a></li> |
| <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li> |
| <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li> |
| <li><a href="#ipp_op_e">ipp_op_e</a></li> |
| <li><a href="#ipp_orient_e">ipp_orient_e</a></li> |
| <li><a href="#ipp_pstate_e">ipp_pstate_e</a></li> |
| <li><a href="#ipp_quality_e">ipp_quality_e</a></li> |
| <li><a href="#ipp_res_e">ipp_res_e</a></li> |
| <li><a href="#ipp_rstate_e">ipp_rstate_e</a></li> |
| <li><a href="#ipp_sstate_e">ipp_sstate_e</a></li> |
| <li><a href="#ipp_state_e">ipp_state_e</a></li> |
| <li><a href="#ipp_status_e">ipp_status_e</a></li> |
| <li><a href="#ipp_tag_e">ipp_tag_e</a></li> |
| </ul></li> |
| </ul> |
| </div> |
| <div class="body"> |
| <blockquote> |
| <p>Please <a href="https://github.com/apple/cups/issues">file issues on Github</a> to provide feedback on this document.</p> |
| </blockquote> |
| <h2><a id="introduction">Introduction</a></h2> |
| <p>CUPS provides the "cups" library to talk to the different parts of CUPS and with Internet Printing Protocol (IPP) printers. The "cups" library functions are accessed by including the <code><cups/cups.h></code> header.</p> |
| <p>CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients (applications) to communicate with a server (the scheduler, printers, etc.) to get a list of destinations, send print jobs, and so forth. You identify which server you want to communicate with using a pointer to the opaque structure <code>http_t</code>. The <code>CUPS_HTTP_DEFAULT</code> constant can be used when you want to talk to the CUPS scheduler.</p> |
| <h3><a id="guidelines">Guidelines</a></h3> |
| <p>When writing software (other than printer drivers) that uses the "cups" library:</p> |
| <ul> |
| <li>Do not use undocumented or deprecated APIs,</li> |
| <li>Do not rely on pre-configured printers,</li> |
| <li>Do not assume that printers support specific features or formats, and</li> |
| <li>Do not rely on implementation details (PPDs, etc.)</li> |
| </ul> |
| <p>CUPS is designed to insulate users and developers from the implementation details of printers and file formats. The goal is to allow an application to supply a print file in a standard format with the user intent ("print four copies, two-sided on A4 media, and staple each copy") and have the printing system manage the printer communication and format conversion needed.</p> |
| <p>Similarly, printer and job management applications can use standard query operations to obtain the status information in a common, generic form and use standard management operations to control the state of those printers and jobs.</p> |
| <blockquote> |
| <p><strong>Note:</strong></p> |
| <p>CUPS printer drivers necessarily depend on specific file formats and certain implementation details of the CUPS software. Please consult the Postscript and raster printer driver developer documentation on <a href="https://www.cups.org/documentation.html">CUPS.org</a> for more information.</p> |
| </blockquote> |
| <h3><a id="terms-used-in-this-document">Terms Used in This Document</a></h3> |
| <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print</em> <em>Job</em> is a collection of one or more documents that are processed by a destination using options supplied when creating the job. A <em>Document</em> is a file (JPEG image, PDF file, etc.) suitable for printing. An <em>Option</em> controls some aspect of printing, such as the media used. <em>Media</em> is the sheets or roll that is printed on. An <em>Attribute</em> is an option encoded for an Internet Printing Protocol (IPP) request.</p> |
| <h3><a id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></h3> |
| <p>The CUPS libraries can be used from any C, C++, or Objective C program. The method of compiling against the libraries varies depending on the operating system and installation of CUPS. The following sections show how to compile a simple program (shown below) in two common environments.</p> |
| <p>The following simple program lists the available destinations:</p> |
| <pre><code>#include <stdio.h> |
| #include <cups/cups.h> |
| |
| int print_dest(void *user_data, unsigned flags, cups_dest_t *dest) |
| { |
| if (dest->instance) |
| printf("%s/%s\n", dest->name, dest->instance); |
| else |
| puts(dest->name); |
| |
| return (1); |
| } |
| |
| int main(void) |
| { |
| cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL); |
| |
| return (0); |
| } |
| </code></pre> |
| <h4><a id="compiling-with-xcode">Compiling with Xcode</a></h4> |
| <p>In Xcode, choose <em>New</em> <em>Project...</em> from the <em>File</em> menu (or press SHIFT+CMD+N), then select the <em>Command</em> <em>Line</em> <em>Tool</em> under the macOS Application project type. Click <em>Next</em> and enter a name for the project, for example "firstcups". Click <em>Next</em> and choose a project directory. The click <em>Next</em> to create the project.</p> |
| <p>In the project window, click on the <em>Build</em> <em>Phases</em> group and expand the <em>Link</em> <em>Binary</em> <em>with</em> <em>Libraries</em> section. Click <em>+</em>, type "libcups" to show the library, and then double-click on <code>libcups.tbd</code>.</p> |
| <p>Finally, click on the <code>main.c</code> file in the sidebar and copy the example program to the file. Build and run (CMD+R) to see the list of destinations.</p> |
| <h4><a id="compiling-with-gcc">Compiling with GCC</a></h4> |
| <p>From the command-line, create a file called <code>simple.c</code> using your favorite editor, copy the example to this file, and save. Then run the following command to compile it with GCC and run it:</p> |
| <pre><code>gcc -o simple `cups-config --cflags` simple.c `cups-config --libs` |
| ./simple |
| </code></pre> |
| <p>The <code>cups-config</code> command provides the compiler flags (<code>cups-config --cflags</code>) and libraries (<code>cups-config --libs</code>) needed for the local system.</p> |
| <h2><a id="working-with-destinations">Working with Destinations</a></h2> |
| <p>Destinations, which in CUPS represent individual printers or classes (collections or pools) of printers, are represented by the <code>cups_dest_t</code> structure which includes the name (<code>name</code>), instance (<code>instance</code>, saved options/settings), whether the destination is the default for the user (<code>is_default</code>), and the options and basic information associated with that destination (<code>num_options</code> and <code>options</code>).</p> |
| <p>Historically destinations have been manually maintained by the administrator of a system or network, but CUPS also supports dynamic discovery of destinations on the current network.</p> |
| <h3><a id="finding-available-destinations">Finding Available Destinations</a></h3> |
| <p>The <code>cupsEnumDests</code> function finds all of the available destinations:</p> |
| <pre><code> int |
| cupsEnumDests(unsigned flags, int msec, int *cancel, |
| cups_ptype_t type, cups_ptype_t mask, |
| cups_dest_cb_t cb, void *user_data) |
| </code></pre> |
| <p>The <code>flags</code> argument specifies enumeration options, which at present must be <code>CUPS_DEST_FLAGS_NONE</code>.</p> |
| <p>The <code>msec</code> argument specifies the maximum amount of time that should be used for enumeration in milliseconds - interactive applications should keep this value to 5000 or less when run on the main thread.</p> |
| <p>The <code>cancel</code> argument points to an integer variable that, when set to a non-zero value, will cause enumeration to stop as soon as possible. It can be <code>NULL</code> if not needed.</p> |
| <p>The <code>type</code> and <code>mask</code> arguments are bitfields that allow the caller to filter the destinations based on categories and/or capabilities. The destination's "printer-type" value is masked by the <code>mask</code> value and compared to the <code>type</code> value when filtering. For example, to only enumerate destinations that are hosted on the local system, pass <code>CUPS_PRINTER_LOCAL</code> for the <code>type</code> argument and <code>CUPS_PRINTER_DISCOVERED</code> for the <code>mask</code> argument. The following constants can be used for filtering:</p> |
| <ul> |
| <li><code>CUPS_PRINTER_CLASS</code>: A collection of destinations.</li> |
| <li><code>CUPS_PRINTER_FAX</code>: A facsimile device.</li> |
| <li><code>CUPS_PRINTER_LOCAL</code>: A local printer or class. This constant has the value 0 (no bits set) and is only used for the <code>type</code> argument and is paired with the <code>CUPS_PRINTER_REMOTE</code> or <code>CUPS_PRINTER_DISCOVERED</code> constant passed in the <code>mask</code> argument.</li> |
| <li><code>CUPS_PRINTER_REMOTE</code>: A remote (shared) printer or class.</li> |
| <li><code>CUPS_PRINTER_DISCOVERED</code>: An available network printer or class.</li> |
| <li><code>CUPS_PRINTER_BW</code>: Can do B&W printing.</li> |
| <li><code>CUPS_PRINTER_COLOR</code>: Can do color printing.</li> |
| <li><code>CUPS_PRINTER_DUPLEX</code>: Can do two-sided printing.</li> |
| <li><code>CUPS_PRINTER_STAPLE</code>: Can staple output.</li> |
| <li><code>CUPS_PRINTER_COLLATE</code>: Can quickly collate copies.</li> |
| <li><code>CUPS_PRINTER_PUNCH</code>: Can punch output.</li> |
| <li><code>CUPS_PRINTER_COVER</code>: Can cover output.</li> |
| <li><code>CUPS_PRINTER_BIND</code>: Can bind output.</li> |
| <li><code>CUPS_PRINTER_SORT</code>: Can sort output (mailboxes, etc.)</li> |
| <li><code>CUPS_PRINTER_SMALL</code>: Can print on Letter/Legal/A4-size media.</li> |
| <li><code>CUPS_PRINTER_MEDIUM</code>: Can print on Tabloid/B/C/A3/A2-size media.</li> |
| <li><code>CUPS_PRINTER_LARGE</code>: Can print on D/E/A1/A0-size media.</li> |
| <li><code>CUPS_PRINTER_VARIABLE</code>: Can print on rolls and custom-size media.</li> |
| </ul> |
| <p>The <code>cb</code> argument specifies a function to call for every destination that is found:</p> |
| <pre><code>typedef int (*cups_dest_cb_t)(void *user_data, |
| unsigned flags, |
| cups_dest_t *dest); |
| </code></pre> |
| <p>The callback function receives a copy of the <code>user_data</code> argument along with a bitfield (<code>flags</code>) and the destination that was found. The <code>flags</code> argument can have any of the following constant (bit) values set:</p> |
| <ul> |
| <li><code>CUPS_DEST_FLAGS_MORE</code>: There are more destinations coming.</li> |
| <li><code>CUPS_DEST_FLAGS_REMOVED</code>: The destination has gone away and should be removed from the list of destinations a user can select.</li> |
| <li><code>CUPS_DEST_FLAGS_ERROR</code>: An error occurred. The reason for the error can be found by calling the <code>cupsLastError</code> and/or <code>cupsLastErrorString</code> functions.</li> |
| </ul> |
| <p>The callback function returns 0 to stop enumeration or 1 to continue.</p> |
| <blockquote> |
| <p><strong>Note:</strong></p> |
| <p>The callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.</p> |
| </blockquote> |
| <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> |
| <pre><code>typedef struct |
| { |
| int num_dests; |
| cups_dest_t *dests; |
| } my_user_data_t; |
| |
| int |
| my_dest_cb(my_user_data_t *user_data, unsigned flags, |
| cups_dest_t *dest) |
| { |
| if (flags & CUPS_DEST_FLAGS_REMOVED) |
| { |
| /* |
| * Remove destination from array... |
| */ |
| |
| user_data->num_dests = |
| cupsRemoveDest(dest->name, dest->instance, |
| user_data->num_dests, |
| &(user_data->dests)); |
| } |
| else |
| { |
| /* |
| * Add destination to array... |
| */ |
| |
| user_data->num_dests = |
| cupsCopyDest(dest, user_data->num_dests, |
| &(user_data->dests)); |
| } |
| |
| return (1); |
| } |
| |
| int |
| my_get_dests(cups_ptype_t type, cups_ptype_t mask, |
| cups_dest_t **dests) |
| { |
| my_user_data_t user_data = { 0, NULL }; |
| |
| if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type, |
| mask, (cups_dest_cb_t)my_dest_cb, |
| &user_data)) |
| { |
| /* |
| * An error occurred, free all of the destinations and |
| * return... |
| */ |
| |
| cupsFreeDests(user_data.num_dests, user_dasta.dests); |
| |
| *dests = NULL; |
| |
| return (0); |
| } |
| |
| /* |
| * Return the destination array... |
| */ |
| |
| *dests = user_data.dests; |
| |
| return (user_data.num_dests); |
| } |
| </code></pre> |
| <h3><a id="basic-destination-information">Basic Destination Information</a></h3> |
| <p>The <code>num_options</code> and <code>options</code> members of the <code>cups_dest_t</code> structure provide basic attributes about the destination in addition to the user default options and values for that destination. The following names are predefined for various destination attributes:</p> |
| <ul> |
| <li>"auth-info-required": The type of authentication required for printing to this destination: "none", "username,password", "domain,username,password", or "negotiate" (Kerberos).</li> |
| <li>"printer-info": The human-readable description of the destination such as "My Laser Printer".</li> |
| <li>"printer-is-accepting-jobs": "true" if the destination is accepting new jobs, "false" otherwise.</li> |
| <li>"printer-is-shared": "true" if the destination is being shared with other computers, "false" otherwise.</li> |
| <li>"printer-location": The human-readable location of the destination such as "Lab 4".</li> |
| <li>"printer-make-and-model": The human-readable make and model of the destination such as "ExampleCorp LaserPrinter 4000 Series".</li> |
| <li>"printer-state": "3" if the destination is idle, "4" if the destination is printing a job, and "5" if the destination is stopped.</li> |
| <li>"printer-state-change-time": The UNIX time when the destination entered the current state.</li> |
| <li>"printer-state-reasons": Additional comma-delimited state keywords for the destination such as "media-tray-empty-error" and "toner-low-warning".</li> |
| <li>"printer-type": The <code>cups_ptype_t</code> value associated with the destination.</li> |
| <li>"printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.</li> |
| </ul> |
| <p>Use the <code>cupsGetOption</code> function to retrieve the value. For example, the following code gets the make and model of a destination:</p> |
| <pre><code>const char *model = cupsGetOption("printer-make-and-model", |
| dest->num_options, |
| dest->options); |
| </code></pre> |
| <h3><a id="detailed-destination-information">Detailed Destination Information</a></h3> |
| <p>Once a destination has been chosen, the <code>cupsCopyDestInfo</code> function can be used to gather detailed information about the destination:</p> |
| <pre><code>cups_dinfo_t * |
| cupsCopyDestInfo(http_t *http, cups_dest_t *dest); |
| </code></pre> |
| <p>The <code>http</code> argument specifies a connection to the CUPS scheduler and is typically the constant <code>CUPS_HTTP_DEFAULT</code>. The <code>dest</code> argument specifies the destination to query.</p> |
| <p>The <code>cups_dinfo_t</code> structure that is returned contains a snapshot of the supported options and their supported, ready, and default values. It also can report constraints between different options and values, and recommend changes to resolve those constraints.</p> |
| <h4><a id="getting-supported-options-and-values">Getting Supported Options and Values</a></h4> |
| <p>The <code>cupsCheckDestSupported</code> function can be used to test whether a particular option or option and value is supported:</p> |
| <pre><code>int |
| cupsCheckDestSupported(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, |
| const char *option, |
| const char *value); |
| </code></pre> |
| <p>The <code>option</code> argument specifies the name of the option to check. The following constants can be used to check the various standard options:</p> |
| <ul> |
| <li><code>CUPS_COPIES</code>: Controls the number of copies that are produced.</li> |
| <li><code>CUPS_FINISHINGS</code>: A comma-delimited list of integer constants that control the finishing processes that are applied to the job, including stapling, punching, and folding.</li> |
| <li><code>CUPS_MEDIA</code>: Controls the media size that is used, typically one of the following: <code>CUPS_MEDIA_3X5</code>, <code>CUPS_MEDIA_4X6</code>, <code>CUPS_MEDIA_5X7</code>, <code>CUPS_MEDIA_8X10</code>, <code>CUPS_MEDIA_A3</code>, <code>CUPS_MEDIA_A4</code>, <code>CUPS_MEDIA_A5</code>, <code>CUPS_MEDIA_A6</code>, <code>CUPS_MEDIA_ENV10</code>, <code>CUPS_MEDIA_ENVDL</code>, <code>CUPS_MEDIA_LEGAL</code>, <code>CUPS_MEDIA_LETTER</code>, <code>CUPS_MEDIA_PHOTO_L</code>, <code>CUPS_MEDIA_SUPERBA3</code>, or <code>CUPS_MEDIA_TABLOID</code>.</li> |
| <li><code>CUPS_MEDIA_SOURCE</code>: Controls where the media is pulled from, typically either <code>CUPS_MEDIA_SOURCE_AUTO</code> or <code>CUPS_MEDIA_SOURCE_MANUAL</code>.</li> |
| <li><code>CUPS_MEDIA_TYPE</code>: Controls the type of media that is used, typically one of the following: <code>CUPS_MEDIA_TYPE_AUTO</code>, <code>CUPS_MEDIA_TYPE_ENVELOPE</code>, <code>CUPS_MEDIA_TYPE_LABELS</code>, <code>CUPS_MEDIA_TYPE_LETTERHEAD</code>, <code>CUPS_MEDIA_TYPE_PHOTO</code>, <code>CUPS_MEDIA_TYPE_PHOTO_GLOSSY</code>, <code>CUPS_MEDIA_TYPE_PHOTO_MATTE</code>, <code>CUPS_MEDIA_TYPE_PLAIN</code>, or <code>CUPS_MEDIA_TYPE_TRANSPARENCY</code>.</li> |
| <li><code>CUPS_NUMBER_UP</code>: Controls the number of document pages that are placed on each media side.</li> |
| <li><code>CUPS_ORIENTATION</code>: Controls the orientation of document pages placed on the media: <code>CUPS_ORIENTATION_PORTRAIT</code> or <code>CUPS_ORIENTATION_LANDSCAPE</code>.</li> |
| <li><code>CUPS_PRINT_COLOR_MODE</code>: Controls whether the output is in color (<code>CUPS_PRINT_COLOR_MODE_COLOR</code>), grayscale (<code>CUPS_PRINT_COLOR_MODE_MONOCHROME</code>), or either (<code>CUPS_PRINT_COLOR_MODE_AUTO</code>).</li> |
| <li><code>CUPS_PRINT_QUALITY</code>: Controls the generate quality of the output: <code>CUPS_PRINT_QUALITY_DRAFT</code>, <code>CUPS_PRINT_QUALITY_NORMAL</code>, or <code>CUPS_PRINT_QUALITY_HIGH</code>.</li> |
| <li><code>CUPS_SIDES</code>: Controls whether prints are placed on one or both sides of the media: <code>CUPS_SIDES_ONE_SIDED</code>, <code>CUPS_SIDES_TWO_SIDED_PORTRAIT</code>, or <code>CUPS_SIDES_TWO_SIDED_LANDSCAPE</code>.</li> |
| </ul> |
| <p>If the <code>value</code> argument is <code>NULL</code>, the <code>cupsCheckDestSupported</code> function returns whether the option is supported by the destination. Otherwise, the function returns whether the specified value of the option is supported.</p> |
| <p>The <code>cupsFindDestSupported</code> function returns the IPP attribute containing the supported values for a given option:</p> |
| <pre><code> ipp_attribute_t * |
| cupsFindDestSupported(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, |
| const char *option); |
| </code></pre> |
| <p>For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:</p> |
| <pre><code>cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, |
| dest); |
| |
| if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| CUPS_FINISHINGS, NULL)) |
| { |
| ipp_attribute_t *finishings = |
| cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| CUPS_FINISHINGS); |
| int i, count = ippGetCount(finishings); |
| |
| puts("finishings supported:"); |
| for (i = 0; i < count; i ++) |
| printf(" %d\n", ippGetInteger(finishings, i)); |
| } |
| else |
| puts("finishings not supported."); |
| </code></pre> |
| <p>The "job-creation-attributes" option can be queried to get a list of supported options. For example, the following code prints the list of supported options to the standard output:</p> |
| <pre><code>ipp_attribute_t *attrs = |
| cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| "job-creation-attributes"); |
| int i, count = ippGetCount(attrs); |
| |
| for (i = 0; i < count; i ++) |
| puts(ippGetString(attrs, i, NULL)); |
| </code></pre> |
| <h4><a id="getting-default-values">Getting Default Values</a></h4> |
| <p>There are two sets of default values - user defaults that are available via the <code>num_options</code> and <code>options</code> members of the <code>cups_dest_t</code> structure, and destination defaults that available via the <code>cups_dinfo_t</code> structure and the <code>cupsFindDestDefault</code> function which returns the IPP attribute containing the default value(s) for a given option:</p> |
| <pre><code>ipp_attribute_t * |
| cupsFindDestDefault(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, |
| const char *option); |
| </code></pre> |
| <p>The user defaults from <code>cupsGetOption</code> should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:</p> |
| <pre><code>const char *def_value = |
| cupsGetOption(CUPS_FINISHINGS, dest->num_options, |
| dest->options); |
| ipp_attribute_t *def_attr = |
| cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, |
| CUPS_FINISHINGS); |
| |
| if (def_value != NULL) |
| { |
| printf("Default finishings: %s\n", def_value); |
| } |
| else |
| { |
| int i, count = ippGetCount(def_attr); |
| |
| printf("Default finishings: %d", |
| ippGetInteger(def_attr, 0)); |
| for (i = 1; i < count; i ++) |
| printf(",%d", ippGetInteger(def_attr, i)); |
| putchar('\n'); |
| } |
| </code></pre> |
| <h4><a id="getting-ready-loaded-values">Getting Ready (Loaded) Values</a></h4> |
| <p>The finishings and media options also support queries for the ready, or loaded, values. For example, a printer may have punch and staple finishers installed but be out of staples - the supported values will list both punch and staple finishing processes but the ready values will only list the punch processes. Similarly, a printer may support hundreds of different sizes of media but only have a single size loaded at any given time - the ready values are limited to the media that is actually in the printer.</p> |
| <p>The <code>cupsFindDestReady</code> function finds the IPP attribute containing the ready values for a given option:</p> |
| <pre><code>ipp_attribute_t * |
| cupsFindDestReady(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, const char *option); |
| </code></pre> |
| <p>For example, the following code lists the ready finishing processes:</p> |
| <pre><code>ipp_attribute_t *ready_finishings = |
| cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, |
| CUPS_FINISHINGS); |
| |
| if (ready_finishings != NULL) |
| { |
| int i, count = ippGetCount(ready_finishings); |
| |
| puts("finishings ready:"); |
| for (i = 0; i < count; i ++) |
| printf(" %d\n", ippGetInteger(ready_finishings, i)); |
| } |
| else |
| puts("no finishings are ready."); |
| </code></pre> |
| <h4><a id="media-size-options">Media Size Options</a></h4> |
| <p>CUPS provides functions for querying the dimensions and margins for each of the supported media size options. The <code>cups_size_t</code> structure is used to describe a media size:</p> |
| <pre><code>typedef struct cups_size_s |
| { |
| char media[128]; |
| int width, length; |
| int bottom, left, right, top; |
| } cups_size_t; |
| </code></pre> |
| <p>The <code>width</code> and <code>length</code> members specify the dimensions of the media in hundredths of millimeters (1/2540th of an inch). The <code>bottom</code>, <code>left</code>, <code>right</code>, and <code>top</code> members specify the margins of the printable area, also in hundredths of millimeters.</p> |
| <p>The <code>cupsGetDestMediaByName</code> and <code>cupsGetDestMediaBySize</code> functions lookup the media size information using a standard media size name or dimensions in hundredths of millimeters:</p> |
| <pre><code>int |
| cupsGetDestMediaByName(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, |
| const char *media, |
| unsigned flags, cups_size_t *size); |
| |
| int |
| cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, |
| int width, int length, |
| unsigned flags, cups_size_t *size); |
| </code></pre> |
| <p>The <code>media</code>, <code>width</code>, and <code>length</code> arguments specify the size to lookup. The <code>flags</code> argument specifies a bitfield controlling various lookup options:</p> |
| <ul> |
| <li><code>CUPS_MEDIA_FLAGS_DEFAULT</code>: Find the closest size supported by the printer.</li> |
| <li><code>CUPS_MEDIA_FLAGS_BORDERLESS</code>: Find a borderless size.</li> |
| <li><code>CUPS_MEDIA_FLAGS_DUPLEX</code>: Find a size compatible with two-sided printing.</li> |
| <li><code>CUPS_MEDIA_FLAGS_EXACT</code>: Find an exact match for the size.</li> |
| <li><code>CUPS_MEDIA_FLAGS_READY</code>: If the printer supports media sensing or configuration of the media in each tray/source, find the size amongst the "ready" media.</li> |
| </ul> |
| <p>If a matching size is found for the destination, the size information is stored in the structure pointed to by the <code>size</code> argument and 1 is returned. Otherwise 0 is returned.</p> |
| <p>For example, the following code prints the margins for two-sided printing on US Letter media:</p> |
| <pre><code>cups_size_t size; |
| |
| if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info, |
| CUPS_MEDIA_LETTER, |
| CUPS_MEDIA_FLAGS_DUPLEX, &size)) |
| { |
| puts("Margins for duplex US Letter:"); |
| printf(" Bottom: %.2fin\n", size.bottom / 2540.0); |
| printf(" Left: %.2fin\n", size.left / 2540.0); |
| printf(" Right: %.2fin\n", size.right / 2540.0); |
| printf(" Top: %.2fin\n", size.top / 2540.0); |
| } |
| else |
| puts("Margins for duplex US Letter are not available."); |
| </code></pre> |
| <p>You can also enumerate all of the sizes that match a given <code>flags</code> value using the <code>cupsGetDestMediaByIndex</code> and <code>cupsGetDestMediaCount</code> functions:</p> |
| <pre><code>int |
| cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, int n, |
| unsigned flags, cups_size_t *size); |
| |
| int |
| cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, unsigned flags); |
| </code></pre> |
| <p>For example, the following code prints the list of ready media and corresponding margins:</p> |
| <pre><code>cups_size_t size; |
| int i; |
| int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, |
| dest, info, |
| CUPS_MEDIA_FLAGS_READY); |
| |
| for (i = 0; i < count; i ++) |
| { |
| if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info, |
| i, CUPS_MEDIA_FLAGS_READY, |
| &size)) |
| { |
| printf("%s:\n", size.name); |
| printf(" Width: %.2fin\n", size.width / 2540.0); |
| printf(" Length: %.2fin\n", size.length / 2540.0); |
| printf(" Bottom: %.2fin\n", size.bottom / 2540.0); |
| printf(" Left: %.2fin\n", size.left / 2540.0); |
| printf(" Right: %.2fin\n", size.right / 2540.0); |
| printf(" Top: %.2fin\n", size.top / 2540.0); |
| } |
| } |
| </code></pre> |
| <p>Finally, the <code>cupsGetDestMediaDefault</code> function returns the default media size:</p> |
| <pre><code>int |
| cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *dinfo, unsigned flags, |
| cups_size_t *size); |
| </code></pre> |
| <h4><a id="localizing-options-and-values">Localizing Options and Values</a></h4> |
| <p>CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: <code>cupsLocalizeDestMedia</code>, <code>cupsLocalizeDestOption</code>, and <code>cupsLocalizeDestValue</code>:</p> |
| <pre><code>const char * |
| cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, unsigned flags, |
| cups_size_t *size); |
| |
| const char * |
| cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, |
| const char *option); |
| |
| const char * |
| cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, |
| const char *option, const char *value); |
| </code></pre> |
| <h3><a id="submitting-a-print-job">Submitting a Print Job</a></h3> |
| <p>Once you are ready to submit a print job, you create a job using the <code>cupsCreateDestJob</code> function:</p> |
| <pre><code>ipp_status_t |
| cupsCreateDestJob(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, int *job_id, |
| const char *title, int num_options, |
| cups_option_t *options); |
| </code></pre> |
| <p>The <code>title</code> argument specifies a name for the print job such as "My Document". The <code>num_options</code> and <code>options</code> arguments specify the options for the print job which are allocated using the <code>cupsAddOption</code> function.</p> |
| <p>When successful, the job's numeric identifier is stored in the integer pointed to by the <code>job_id</code> argument and <code>IPP_STATUS_OK</code> is returned. Otherwise, an IPP error status is returned.</p> |
| <p>For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:</p> |
| <pre><code>int job_id = 0; |
| int num_options = 0; |
| cups_option_t *options = NULL; |
| |
| num_options = cupsAddOption(CUPS_COPIES, "42", |
| num_options, &options); |
| num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, |
| num_options, &options); |
| num_options = cupsAddOption(CUPS_SIDES, |
| CUPS_SIDES_TWO_SIDED_PORTRAIT, |
| num_options, &options); |
| |
| if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, |
| &job_id, "My Document", num_options, |
| options) == IPP_STATUS_OK) |
| printf("Created job: %d\n", job_id); |
| else |
| printf("Unable to create job: %s\n", |
| cupsLastErrorString()); |
| </code></pre> |
| <p>Once the job is created, you submit documents for the job using the <code>cupsStartDestDocument</code>, <code>cupsWriteRequestData</code>, and <code>cupsFinishDestDocument</code> functions:</p> |
| <pre><code>http_status_t |
| cupsStartDestDocument(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info, int job_id, |
| const char *docname, |
| const char *format, |
| int num_options, |
| cups_option_t *options, |
| int last_document); |
| |
| http_status_t |
| cupsWriteRequestData(http_t *http, const char *buffer, |
| size_t length); |
| |
| ipp_status_t |
| cupsFinishDestDocument(http_t *http, cups_dest_t *dest, |
| cups_dinfo_t *info); |
| </code></pre> |
| <p>The <code>docname</code> argument specifies the name of the document, typically the original filename. The <code>format</code> argument specifies the MIME media type of the document, including the following constants:</p> |
| <ul> |
| <li><code>CUPS_FORMAT_JPEG</code>: "image/jpeg"</li> |
| <li><code>CUPS_FORMAT_PDF</code>: "application/pdf"</li> |
| <li><code>CUPS_FORMAT_POSTSCRIPT</code>: "application/postscript"</li> |
| <li><code>CUPS_FORMAT_TEXT</code>: "text/plain"</li> |
| </ul> |
| <p>The <code>num_options</code> and <code>options</code> arguments specify per-document print options, which at present must be 0 and <code>NULL</code>. The <code>last_document</code> argument specifies whether this is the last document in the job.</p> |
| <p>For example, the following code submits a PDF file to the job that was just created:</p> |
| <pre><code>FILE *fp = fopen("filename.pdf", "rb"); |
| size_t bytes; |
| char buffer[65536]; |
| |
| if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, |
| job_id, "filename.pdf", 0, NULL, |
| 1) == HTTP_STATUS_CONTINUE) |
| { |
| while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0) |
| if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, |
| bytes) != HTTP_STATUS_CONTINUE) |
| break; |
| |
| if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, |
| info) == IPP_STATUS_OK) |
| puts("Document send succeeded."); |
| else |
| printf("Document send failed: %s\n", |
| cupsLastErrorString()); |
| } |
| |
| fclose(fp); |
| </code></pre> |
| <h2><a id="sending-ipp-requests">Sending IPP Requests</a></h2> |
| <p>CUPS provides a rich API for sending IPP requests to the scheduler or printers, typically from management or utility applications whose primary purpose is not to send print jobs.</p> |
| <h3><a id="connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></h3> |
| <p>The connection to the scheduler or printer is represented by the HTTP connection type <code>http_t</code>. The <code>cupsConnectDest</code> function connects to the scheduler or printer associated with the destination:</p> |
| <pre><code>http_t * |
| cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec, |
| int *cancel, char *resource, |
| size_t resourcesize, cups_dest_cb_t cb, |
| void *user_data); |
| </code></pre> |
| <p>The <code>dest</code> argument specifies the destination to connect to.</p> |
| <p>The <code>flags</code> argument specifies whether you want to connect to the scheduler (<code>CUPS_DEST_FLAGS_NONE</code>) or device/printer (<code>CUPS_DEST_FLAGS_DEVICE</code>) associated with the destination.</p> |
| <p>The <code>msec</code> argument specifies how long you are willing to wait for the connection to be established in milliseconds. Specify a value of <code>-1</code> to wait indefinitely.</p> |
| <p>The <code>cancel</code> argument specifies the address of an integer variable that can be set to a non-zero value to cancel the connection. Specify a value of <code>NULL</code> to not provide a cancel variable.</p> |
| <p>The <code>resource</code> and <code>resourcesize</code> arguments specify the address and size of a character string array to hold the path to use when sending an IPP request.</p> |
| <p>The <code>cb</code> and <code>user_data</code> arguments specify a destination callback function that returns 1 to continue connecting or 0 to stop. The destination callback work the same way as the one used for the <code>cupsEnumDests</code> function.</p> |
| <p>On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.</p> |
| <p>For example, the following code connects to the printer associated with a destination with a 30 second timeout:</p> |
| <pre><code>char resource[256]; |
| http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, |
| 30000, NULL, resource, |
| sizeof(resource), NULL, NULL); |
| </code></pre> |
| <h3><a id="creating-an-ipp-request">Creating an IPP Request</a></h3> |
| <p>IPP requests are represented by the IPP message type <code>ipp_t</code> and each IPP attribute in the request is representing using the type <code>ipp_attribute_t</code>. Each IPP request includes an operation code (<code>IPP_OP_CREATE_JOB</code>, <code>IPP_OP_GET_PRINTER_ATTRIBUTES</code>, etc.) and a 32-bit integer identifier.</p> |
| <p>The <code>ippNewRequest</code> function creates a new IPP request:</p> |
| <pre><code>ipp_t * |
| ippNewRequest(ipp_op_t op); |
| </code></pre> |
| <p>The <code>op</code> argument specifies the IPP operation code for the request. For example, the following code creates an IPP Get-Printer-Attributes request:</p> |
| <pre><code>ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); |
| </code></pre> |
| <p>The request identifier is automatically set to a unique value for the current process.</p> |
| <p>Each IPP request starts with two IPP attributes, "attributes-charset" and "attributes-natural-language", followed by IPP attribute(s) that specify the target of the operation. The <code>ippNewRequest</code> automatically adds the correct "attributes-charset" and "attributes-natural-language" attributes, but you must add the target attribute(s). For example, the following code adds the "printer-uri" attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried:</p> |
| <pre><code>const char *printer_uri = cupsGetOption("device-uri", |
| dest->num_options, |
| dest->options); |
| |
| ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, |
| "printer-uri", NULL, printer_uri); |
| </code></pre> |
| <blockquote> |
| <p><strong>Note:</strong></p> |
| <p>If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.</p> |
| </blockquote> |
| <p>The <code>ippAddString</code> function adds the "printer-uri" attribute the the IPP request. The <code>IPP_TAG_OPERATION</code> argument specifies that the attribute is part of the operation. The <code>IPP_TAG_URI</code> argument specifies that the value is a Universal Resource Identifier (URI) string. The <code>NULL</code> argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the <code>printer_uri</code> argument specifies the string value.</p> |
| <p>The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:</p> |
| <pre><code>static const char * const requested_attributes[] = |
| { |
| "printer-state", |
| "printer-state-message", |
| "printer-state-reasons" |
| }; |
| |
| ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, |
| "requested-attributes", 3, NULL, |
| requested_attributes); |
| </code></pre> |
| <p>The <code>ippAddStrings</code> function adds an attribute with one or more strings, in this case three. The <code>IPP_TAG_KEYWORD</code> argument specifies that the strings are keyword values, which are used for attribute names. All strings use the same language (<code>NULL</code>), and the attribute will contain the three strings in the array <code>requested_attributes</code>.</p> |
| <p>CUPS provides many functions to adding attributes of different types:</p> |
| <ul> |
| <li><code>ippAddBoolean</code> adds a boolean (<code>IPP_TAG_BOOLEAN</code>) attribute with one value.</li> |
| <li><code>ippAddInteger</code> adds an enum (<code>IPP_TAG_ENUM</code>) or integer (<code>IPP_TAG_INTEGER</code>) attribute with one value.</li> |
| <li><code>ippAddIntegers</code> adds an enum or integer attribute with one or more values.</li> |
| <li><code>ippAddOctetString</code> adds an octetString attribute with one value.</li> |
| <li><code>ippAddOutOfBand</code> adds a admin-defined (<code>IPP_TAG_ADMINDEFINE</code>), default (<code>IPP_TAG_DEFAULT</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable (<code>IPP_TAG_NOTSETTABLE</code>), unknown (<code>IPP_TAG_UNKNOWN</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_VALUE</code>) out-of-band attribute.</li> |
| <li><code>ippAddRange</code> adds a rangeOfInteger attribute with one range.</li> |
| <li><code>ippAddRanges</code> adds a rangeOfInteger attribute with one or more ranges.</li> |
| <li><code>ippAddResolution</code> adds a resolution attribute with one resolution.</li> |
| <li><code>ippAddResolutions</code> adds a resolution attribute with one or more resolutions.</li> |
| <li><code>ippAddString</code> adds a charset (<code>IPP_TAG_CHARSET</code>), keyword (<code>IPP_TAG_KEYWORD</code>), mimeMediaType (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code> and <code>IPP_TAG_NAMELANG</code>), naturalLanguage (<code>IPP_TAG_NATURAL_LANGUAGE</code>), text (<code>IPP_TAG_TEXT</code> and <code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), or uriScheme (<code>IPP_TAG_URISCHEME</code>) attribute with one value.</li> |
| <li><code>ippAddStrings</code> adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.</li> |
| </ul> |
| <h3><a id="sending-the-ipp-request">Sending the IPP Request</a></h3> |
| <p>Once you have created the IPP request, you can send it using the <code>cupsDoRequest</code> function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:</p> |
| <pre><code>ipp_t *response = cupsDoRequest(http, request, resource); |
| </code></pre> |
| <p>For requests like Send-Document that include a file, the <code>cupsDoFileRequest</code> function should be used:</p> |
| <pre><code>ipp_t *response = cupsDoFileRequest(http, request, resource, |
| filename); |
| </code></pre> |
| <p>Both <code>cupsDoRequest</code> and <code>cupsDoFileRequest</code> free the IPP request. If a valid IPP response is received, it is stored in a new IPP message (<code>ipp_t</code>) and returned to the caller. Otherwise <code>NULL</code> is returned.</p> |
| <p>The status from the most recent request can be queried using the <code>cupsLastError</code> function, for example:</p> |
| <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) |
| { |
| /* request failed */ |
| } |
| </code></pre> |
| <p>A human-readable error message is also available using the <code>cupsLastErrorString</code> function:</p> |
| <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) |
| { |
| /* request failed */ |
| printf("Request failed: %s\n", cupsLastErrorString()); |
| } |
| </code></pre> |
| <h3><a id="processing-the-ipp-response">Processing the IPP Response</a></h3> |
| <p>Each response to an IPP request is also an IPP message (<code>ipp_t</code>) with its own IPP attributes (<code>ipp_attribute_t</code>) that includes a status code (<code>IPP_STATUS_OK</code>, <code>IPP_STATUS_ERROR_BAD_REQUEST</code>, etc.) and the corresponding 32-bit integer identifier from the request.</p> |
| <p>For example, the following code finds the printer state attributes and prints their values:</p> |
| <pre><code>ipp_attribute_t *attr; |
| |
| if ((attr = ippFindAttribute(response, "printer-state", |
| IPP_TAG_ENUM)) != NULL) |
| { |
| printf("printer-state=%s\n", |
| ippEnumString("printer-state", ippGetInteger(attr, 0))); |
| } |
| else |
| puts("printer-state=unknown"); |
| |
| if ((attr = ippFindAttribute(response, "printer-state-message", |
| IPP_TAG_TEXT)) != NULL) |
| { |
| printf("printer-state-message=\"%s\"\n", |
| ippGetString(attr, 0, NULL))); |
| } |
| |
| if ((attr = ippFindAttribute(response, "printer-state-reasons", |
| IPP_TAG_KEYWORD)) != NULL) |
| { |
| int i, count = ippGetCount(attr); |
| |
| puts("printer-state-reasons="); |
| for (i = 0; i < count; i ++) |
| printf(" %s\n", ippGetString(attr, i, NULL))); |
| } |
| </code></pre> |
| <p>The <code>ippGetCount</code> function returns the number of values in an attribute.</p> |
| <p>The <code>ippGetInteger</code> and <code>ippGetString</code> functions return a single integer or string value from an attribute.</p> |
| <p>The <code>ippEnumString</code> function converts a enum value to its keyword (string) equivalent.</p> |
| <p>Once you are done using the IPP response message, free it using the <code>ippDelete</code> function:</p> |
| <pre><code>ippDelete(response); |
| </code></pre> |
| <h3><a id="authentication">Authentication</a></h3> |
| <p>CUPS normally handles authentication through the console. GUI applications should set a password callback using the <code>cupsSetPasswordCB2</code> function:</p> |
| <pre><code>void |
| cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data); |
| </code></pre> |
| <p>The password callback will be called when needed and is responsible for setting the current user name using <code>cupsSetUser</code> and returning a string:</p> |
| <pre><code>const char * |
| cups_password_cb2(const char *prompt, http_t *http, |
| const char *method, const char *resource, |
| void *user_data); |
| </code></pre> |
| <p>The <code>prompt</code> argument is a string from CUPS that should be displayed to the user.</p> |
| <p>The <code>http</code> argument is the connection hosting the request that is being authenticated. The password callback can call the <code>httpGetField</code> and <code>httpGetSubField</code> functions to look for additional details concerning the authentication challenge.</p> |
| <p>The <code>method</code> argument specifies the HTTP method used for the request and is typically "POST".</p> |
| <p>The <code>resource</code> argument specifies the path used for the request.</p> |
| <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p> |
| <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> |
| <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3> |
| <p class="description">Add a destination to the list of destinations.</p> |
| <p class="code"> |
| int cupsAddDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Destination name</td></tr> |
| <tr><th>instance</th> |
| <td class="description">Instance name or <code>NULL</code> for none/primary</td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New number of destinations</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function cannot be used to add a new class or printer queue, |
| it only adds a new container of saved options for the named |
| destination or instance.<br> |
| <br> |
| If the named destination already exists, the destination list is |
| returned unchanged. Adding a new instance of a destination creates |
| a copy of that destination's options.<br> |
| <br> |
| Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of |
| destinations to the user's lpoptions file.</p> |
| <h3 class="function"><span class="info"> CUPS 2.3/macOS 10.14 </span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3> |
| <p class="description">Add the option corresponding to the specified media size.</p> |
| <p class="code"> |
| int cupsAddDestMediaOptions(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media matching flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Current number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New number of options</p> |
| <h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsAddIntegerOption">cupsAddIntegerOption</a></h3> |
| <p class="description">Add an integer option to an option array.</p> |
| <p class="code"> |
| int cupsAddIntegerOption(const char *name, int value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Name of option</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value of option</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Pointer to options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of options</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">New option arrays can be initialized simply by passing 0 for the |
| "num_options" parameter. |
| |
| </p> |
| <h3 class="function"><a id="cupsAddOption">cupsAddOption</a></h3> |
| <p class="description">Add an option to an option array.</p> |
| <p class="code"> |
| int cupsAddOption(const char *name, const char *value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Name of option</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value of option</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Pointer to options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of options</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">New option arrays can be initialized simply by passing 0 for the |
| "num_options" parameter.</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCancelDestJob">cupsCancelDestJob</a></h3> |
| <p class="description">Cancel a job on a destination.</p> |
| <p class="code"> |
| ipp_status_t cupsCancelDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, int job_id);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>job_id</th> |
| <td class="description">Job ID</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of cancel operation</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> |
| <br> |
| Returns <code>IPP_STATUS_OK</code> on success and |
| <code>IPP_STATUS_ERROR_NOT_AUTHORIZED</code> or |
| <code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> |
| <p class="description">Check that the option and value are supported |
| by the destination.</p> |
| <p class="code"> |
| int cupsCheckDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value or <code>NULL</code></td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if supported, 0 otherwise</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns 1 if supported, 0 otherwise. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCloseDestJob">cupsCloseDestJob</a></h3> |
| <p class="description">Close a job and start printing.</p> |
| <p class="code"> |
| ipp_status_t cupsCloseDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>info</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>job_id</th> |
| <td class="description">Job ID</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP status code</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". |
| "job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code> |
| on success. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsConnectDest">cupsConnectDest</a></h3> |
| <p class="description">Open a connection to the destination.</p> |
| <p class="code"> |
| <a href="#http_t">http_t</a> *cupsConnectDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, unsigned flags, int msec, int *cancel, char *resource, size_t resourcesize, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Connection flags</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Timeout in milliseconds</td></tr> |
| <tr><th>cancel</th> |
| <td class="description">Pointer to "cancel" variable</td></tr> |
| <tr><th>resource</th> |
| <td class="description">Resource buffer</td></tr> |
| <tr><th>resourcesize</th> |
| <td class="description">Size of resource buffer</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Callback function</td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data pointer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Connection to destination or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Connect to the destination, returning a new <code>http_t</code> connection object |
| and optionally the resource path to use for the destination. These calls |
| will block until a connection is made, the timeout expires, the integer |
| pointed to by "cancel" is non-zero, or the callback function (or block) |
| returns 0. The caller is responsible for calling <a href="#httpClose"><code>httpClose</code></a> on the |
| returned connection.<br> |
| <br> |
| Starting with CUPS 2.2.4, the caller can pass <code>CUPS_DEST_FLAGS_DEVICE</code> |
| for the "flags" argument to connect directly to the device associated with |
| the destination. Otherwise, the connection is made to the CUPS scheduler |
| associated with the destination. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDest">cupsCopyDest</a></h3> |
| <p class="description">Copy a destination.</p> |
| <p class="code"> |
| int cupsCopyDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dest</th> |
| <td class="description">Destination to copy</td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destination array</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New number of destinations</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Make a copy of the destination to an array of destinations (or just a single |
| copy) - for use with the cupsEnumDests* functions. The caller is responsible |
| for calling cupsFreeDests() on the returned object(s). |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> |
| <p class="description">Get conflicts and resolutions for a new |
| option/value pair.</p> |
| <p class="code"> |
| int cupsCopyDestConflicts(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, const char *new_option, const char *new_value, int *num_conflicts, <a href="#cups_option_t">cups_option_t</a> **conflicts, int *num_resolved, <a href="#cups_option_t">cups_option_t</a> **resolved);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of current options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Current options</td></tr> |
| <tr><th>new_option</th> |
| <td class="description">New option</td></tr> |
| <tr><th>new_value</th> |
| <td class="description">New value</td></tr> |
| <tr><th>num_conflicts</th> |
| <td class="description">Number of conflicting options</td></tr> |
| <tr><th>conflicts</th> |
| <td class="description">Conflicting options</td></tr> |
| <tr><th>num_resolved</th> |
| <td class="description">Number of options to resolve</td></tr> |
| <tr><th>resolved</th> |
| <td class="description">Resolved options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if there is a conflict, 0 if none, -1 on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">"num_options" and "options" represent the currently selected options by the |
| user. "new_option" and "new_value" are the setting the user has just |
| changed.<br> |
| <br> |
| Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if |
| there was an unrecoverable error such as a resolver loop.<br> |
| <br> |
| If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to |
| contain the list of conflicting option/value pairs. Similarly, if |
| "num_resolved" and "resolved" are not <code>NULL</code> they will be set to the |
| list of changes needed to resolve the conflict.<br> |
| <br> |
| If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set |
| to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> |
| <p class="description">Get the supported values/capabilities for the |
| destination.</p> |
| <p class="code"> |
| <a href="#cups_dinfo_t">cups_dinfo_t</a> *cupsCopyDestInfo(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Destination information</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return |
| value. <code>NULL</code> is returned on error. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCreateDestJob">cupsCreateDestJob</a></h3> |
| <p class="description">Create a job on a destination.</p> |
| <p class="code"> |
| ipp_status_t cupsCreateDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int *job_id, const char *title, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>info</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>job_id</th> |
| <td class="description">Job ID or 0 on error</td></tr> |
| <tr><th>title</th> |
| <td class="description">Job name</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of job options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Job options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP status code</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID |
| in the variable pointed to by "job_id". |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a id="cupsDoAuthentication">cupsDoAuthentication</a></h3> |
| <p class="description">Authenticate a request.</p> |
| <p class="code"> |
| int cupsDoAuthentication(<a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>method</th> |
| <td class="description">Request method ("GET", "POST", "PUT")</td></tr> |
| <tr><th>resource</th> |
| <td class="description">Resource path</td></tr> |
| </tbody></table> |
| <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 should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code> |
| status, prior to resubmitting your request. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.3/macOS 10.14 </span><a id="cupsEncodeOption">cupsEncodeOption</a></h3> |
| <p class="description">Encode a single option into an IPP attribute.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsEncodeOption(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group_tag, const char *name, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP request/response</td></tr> |
| <tr><th>group_tag</th> |
| <td class="description">Attribute group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Option name</td></tr> |
| <tr><th>value</th> |
| <td class="description">Option string value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute or <code>NULL</code> on error</p> |
| <h3 class="function"><a id="cupsEncodeOptions">cupsEncodeOptions</a></h3> |
| <p class="description">Encode printer options into IPP attributes.</p> |
| <p class="code"> |
| void cupsEncodeOptions(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP request/response</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function adds operation, job, and then subscription attributes, |
| in that order. Use the <a href="#cupsEncodeOptions2"><code>cupsEncodeOptions2</code></a> function to add attributes |
| for a single group.</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsEncodeOptions2">cupsEncodeOptions2</a></h3> |
| <p class="description">Encode printer options into IPP attributes for a group.</p> |
| <p class="code"> |
| void cupsEncodeOptions2(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, ipp_tag_t group_tag);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP request/response</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| <tr><th>group_tag</th> |
| <td class="description">Group to encode</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function only adds attributes for a single group. Call this |
| function multiple times for each group, or use <a href="#cupsEncodeOptions"><code>cupsEncodeOptions</code></a> |
| to add the standard groups. |
| |
| </p> |
| <h3 class="function"><a id="cupsEncryption">cupsEncryption</a></h3> |
| <p class="description">Get the current encryption settings.</p> |
| <p class="code"> |
| <a href="#http_encryption_t">http_encryption_t</a> cupsEncryption(void);</p> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Encryption settings</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION |
| environment variable, then the ~/.cups/client.conf file, and finally the |
| /etc/cups/client.conf file. If not set, the default is |
| <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> |
| <br> |
| Note: The current encryption setting is tracked separately for each thread |
| in a program. Multi-threaded programs that override the setting via the |
| <a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same |
| setting to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsEnumDests">cupsEnumDests</a></h3> |
| <p class="description">Enumerate available destinations with a callback function.</p> |
| <p class="code"> |
| int cupsEnumDests(unsigned flags, int msec, int *cancel, <a href="#cups_ptype_t">cups_ptype_t</a> type, <a href="#cups_ptype_t">cups_ptype_t</a> mask, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>flags</th> |
| <td class="description">Enumeration flags</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Timeout in milliseconds, -1 for indefinite</td></tr> |
| <tr><th>cancel</th> |
| <td class="description">Pointer to "cancel" variable</td></tr> |
| <tr><th>type</th> |
| <td class="description">Printer type bits</td></tr> |
| <tr><th>mask</th> |
| <td class="description">Mask for printer type bits</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Callback function</td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Destinations are enumerated from one or more sources. The callback function |
| receives the <code>user_data</code> pointer and the destination pointer which can |
| be used as input to the <a href="#cupsCopyDest"><code>cupsCopyDest</code></a> function. The function must |
| return 1 to continue enumeration or 0 to stop.<br> |
| <br> |
| The <code>type</code> and <code>mask</code> arguments allow the caller to filter the |
| destinations that are enumerated. Passing 0 for both will enumerate all |
| printers. The constant <code>CUPS_PRINTER_DISCOVERED</code> is used to filter on |
| destinations that are available but have not yet been added locally.<br> |
| <br> |
| Enumeration happens on the current thread and does not return until all |
| destinations have been enumerated or the callback function returns 0.<br> |
| <br> |
| Note: The callback function will likely receive multiple updates for the same |
| destinations - it is up to the caller to suppress any duplicate destinations. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3> |
| <p class="description">Find the default value(s) for the given option.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option/attribute name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Default attribute or <code>NULL</code> for none</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| functions to inspect the default value(s) as needed. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestReady">cupsFindDestReady</a></h3> |
| <p class="description">Find the default value(s) for the given option.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestReady(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option/attribute name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Default attribute or <code>NULL</code> for none</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| functions to inspect the default value(s) as needed. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestSupported">cupsFindDestSupported</a></h3> |
| <p class="description">Find the default value(s) for the given option.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option/attribute name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Default attribute or <code>NULL</code> for none</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| functions to inspect the default value(s) as needed. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> |
| <p class="description">Finish the current document.</p> |
| <p class="code"> |
| ipp_status_t cupsFinishDestDocument(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>info</th> |
| <td class="description">Destination information</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of document submission</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> |
| <p class="description">Free destination information obtained using |
| <a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> |
| <p class="code"> |
| void cupsFreeDestInfo(<a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="cupsFreeDests">cupsFreeDests</a></h3> |
| <p class="description">Free the memory used by the list of destinations.</p> |
| <p class="code"> |
| void cupsFreeDests(int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="cupsFreeJobs">cupsFreeJobs</a></h3> |
| <p class="description">Free memory used by job data.</p> |
| <p class="code"> |
| void cupsFreeJobs(int num_jobs, <a href="#cups_job_t">cups_job_t</a> *jobs);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>num_jobs</th> |
| <td class="description">Number of jobs</td></tr> |
| <tr><th>jobs</th> |
| <td class="description">Jobs</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="cupsFreeOptions">cupsFreeOptions</a></h3> |
| <p class="description">Free all memory used by options.</p> |
| <p class="code"> |
| void cupsFreeOptions(int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Pointer to options</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="cupsGetDest">cupsGetDest</a></h3> |
| <p class="description">Get the named destination from the list.</p> |
| <p class="code"> |
| <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> |
| <tr><th>instance</th> |
| <td class="description">Instance name or <code>NULL</code></td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Destination pointer or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Use the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a |
| list of supported destinations for the current user.</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3> |
| <p class="description">Get a media name, dimension, and margins for a |
| specific size.</p> |
| <p class="code"> |
| int cupsGetDestMediaByIndex(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int n, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>n</th> |
| <td class="description">Media size number (0-based)</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size information</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed. For |
| example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth |
| borderless size supported by the printer. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> |
| <p class="description">Get media names, dimensions, and margins.</p> |
| <p class="code"> |
| int cupsGetDestMediaByName(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *media, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>media</th> |
| <td class="description">Media name</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media matching flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size information</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on match, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching |
| guidance (multiple flags can be combined):<br> |
| <br> |
| CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| size amongst the "ready" media.<br> |
| <br> |
| The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| <br> |
| Returns 1 when there is a match and 0 if there is not a match. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> |
| <p class="description">Get media names, dimensions, and margins.</p> |
| <p class="code"> |
| int cupsGetDestMediaBySize(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int width, int length, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>width</th> |
| <td class="description">Media width in hundredths of |
| of millimeters</td></tr> |
| <tr><th>length</th> |
| <td class="description">Media length in hundredths of |
| of millimeters</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media matching flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size information</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on match, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. |
| "Flags" provides some matching guidance (multiple flags can be combined):<br> |
| <br> |
| CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| size amongst the "ready" media.<br> |
| <br> |
| The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| <br> |
| Returns 1 when there is a match and 0 if there is not a match. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3> |
| <p class="description">Get the number of sizes supported by a |
| destination.</p> |
| <p class="code"> |
| int cupsGetDestMediaCount(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media flags</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of sizes</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are |
| counted. For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return |
| the number of borderless sizes. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3> |
| <p class="description">Get the default size for a destination.</p> |
| <p class="code"> |
| int cupsGetDestMediaDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size information</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>flags</code> parameter determines which default size is returned. For |
| example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default |
| borderless size, typically US Letter or A4, but sometimes 4x6 photo media. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsGetDestWithURI">cupsGetDestWithURI</a></h3> |
| <p class="description">Get a destination associated with a URI.</p> |
| <p class="code"> |
| <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI(const char *name, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Desired printer name or <code>NULL</code></td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI for the printer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Destination or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">"name" is the desired name for the printer. If <code>NULL</code>, a name will be |
| created using the URI.<br> |
| <br> |
| "uri" is the "ipp" or "ipps" URI for the printer. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetDests2">cupsGetDests2</a></h3> |
| <p class="description">Get the list of destinations from the specified server.</p> |
| <p class="code"> |
| int cupsGetDests2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of destinations</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the |
| "printer-info", "printer-is-accepting-jobs", "printer-is-shared", |
| "printer-make-and-model", "printer-state", "printer-state-change-time", |
| "printer-state-reasons", "printer-type", and "printer-uri-supported" |
| attributes as options.<br> |
| <br> |
| CUPS 1.4 adds the "marker-change-time", "marker-colors", |
| "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message", |
| "marker-names", "marker-types", and "printer-commands" attributes as options.<br> |
| <br> |
| CUPS 2.2 adds accessible IPP printers to the list of destinations that can |
| be used. The "printer-uri-supported" option will be present for those IPP |
| printers that have been recently used.<br> |
| <br> |
| Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and |
| the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsGetIntegerOption">cupsGetIntegerOption</a></h3> |
| <p class="description">Get an integer option value.</p> |
| <p class="code"> |
| int cupsGetIntegerOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Name of option</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Option value or <code>INT_MIN</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">INT_MIN is returned when the option does not exist, is not an integer, or |
| exceeds the range of values for the "int" type. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetJobs2">cupsGetJobs2</a></h3> |
| <p class="description">Get the jobs from the specified server.</p> |
| <p class="code"> |
| int cupsGetJobs2(<a href="#http_t">http_t</a> *http, <a href="#cups_job_t">cups_job_t</a> **jobs, const char *name, int myjobs, int whichjobs);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>jobs</th> |
| <td class="description">Job data</td></tr> |
| <tr><th>name</th> |
| <td class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</td></tr> |
| <tr><th>myjobs</th> |
| <td class="description">0 = all users, 1 = mine</td></tr> |
| <tr><th>whichjobs</th> |
| <td class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of jobs</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless |
| of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are |
| pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns |
| jobs that are stopped, canceled, aborted, or completed. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetNamedDest">cupsGetNamedDest</a></h3> |
| <p class="description">Get options for the named destination.</p> |
| <p class="code"> |
| <a href="#cups_dest_t">cups_dest_t</a> *cupsGetNamedDest(<a href="#http_t">http_t</a> *http, const char *name, const char *instance);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>name</th> |
| <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> |
| <tr><th>instance</th> |
| <td class="description">Instance name or <code>NULL</code></td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Destination or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function is optimized for retrieving a single destination and should |
| be used instead of <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you |
| either know the name of the destination or want to print to the default |
| destination. If <code>NULL</code> is returned, the destination does not exist or |
| there is no default destination.<br> |
| <br> |
| If "http" is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print |
| server will be used.<br> |
| <br> |
| If "name" is <code>NULL</code>, the default printer for the current user will be |
| returned.<br> |
| <br> |
| The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a |
| "num_dests" value of 1. |
| |
| </p> |
| <h3 class="function"><a id="cupsGetOption">cupsGetOption</a></h3> |
| <p class="description">Get an option value.</p> |
| <p class="code"> |
| const char *cupsGetOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Name of option</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Option value or <code>NULL</code></p> |
| <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetPassword2">cupsGetPassword2</a></h3> |
| <p class="description">Get a password from the user using the current |
| password callback.</p> |
| <p class="code"> |
| const char *cupsGetPassword2(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>prompt</th> |
| <td class="description">Prompt string</td></tr> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>method</th> |
| <td class="description">Request method ("GET", "POST", "PUT")</td></tr> |
| <tr><th>resource</th> |
| <td class="description">Resource path</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Password</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the |
| user does not provide a password.<br> |
| <br> |
| Note: The current password callback function is tracked separately for each |
| thread in a program. Multi-threaded programs that override the setting via |
| the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function need to do so in each thread for the |
| same function to be used. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3> |
| <p class="description">Get the localized string for a destination media |
| size.</p> |
| <p class="code"> |
| const char *cupsLocalizeDestMedia(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>flags</th> |
| <td class="description">Media flags</td></tr> |
| <tr><th>size</th> |
| <td class="description">Media size</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Localized string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned string is stored in the destination information and will become |
| invalid if the destination information is deleted. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> |
| <p class="description">Get the localized string for a destination |
| option.</p> |
| <p class="code"> |
| const char *cupsLocalizeDestOption(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option to localize</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Localized string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned string is stored in the destination information and will become |
| invalid if the destination information is deleted. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> |
| <p class="description">Get the localized string for a destination |
| option+value pair.</p> |
| <p class="code"> |
| const char *cupsLocalizeDestValue(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>dinfo</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>option</th> |
| <td class="description">Option to localize</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value to localize</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Localized string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The returned string is stored in the destination information and will become |
| invalid if the destination information is deleted. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="cupsMakeServerCredentials">cupsMakeServerCredentials</a></h3> |
| <p class="description">Make a self-signed certificate and private key pair.</p> |
| <p class="code"> |
| int cupsMakeServerCredentials(const char *path, const char *common_name, int num_alt_names, const char **alt_names, time_t expiration_date);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>path</th> |
| <td class="description">Keychain path or <code>NULL</code> for default</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Common name</td></tr> |
| <tr><th>num_alt_names</th> |
| <td class="description">Number of subject alternate names</td></tr> |
| <tr><th>alt_names</th> |
| <td class="description">Subject Alternate Names</td></tr> |
| <tr><th>expiration_date</th> |
| <td class="description">Expiration date</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h3 class="function"><a id="cupsParseOptions">cupsParseOptions</a></h3> |
| <p class="description">Parse options from a command-line argument.</p> |
| <p class="code"> |
| int cupsParseOptions(const char *arg, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>arg</th> |
| <td class="description">Argument to parse</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options found</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of options found</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function converts space-delimited name/value pairs according |
| to the PAPI text option ABNF specification. Collection values |
| ("name={a=... b=... c=...}") are stored with the curley brackets |
| intact - use <code>cupsParseOptions</code> on the value to extract the |
| collection attributes.</p> |
| <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsRemoveDest">cupsRemoveDest</a></h3> |
| <p class="description">Remove a destination from the destination list.</p> |
| <p class="code"> |
| int cupsRemoveDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Destination name</td></tr> |
| <tr><th>instance</th> |
| <td class="description">Instance name or <code>NULL</code></td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New number of destinations</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Removing a destination/instance does not delete the class or printer |
| queue, merely the lpoptions for that destination/instance. Use the |
| <a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new |
| options for the user. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRemoveOption">cupsRemoveOption</a></h3> |
| <p class="description">Remove an option from an option array.</p> |
| <p class="code"> |
| int cupsRemoveOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Option name</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Current number of options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New number of options</p> |
| <h3 class="function"><a id="cupsServer">cupsServer</a></h3> |
| <p class="description">Return the hostname/address of the current server.</p> |
| <p class="code"> |
| const char *cupsServer(void);</p> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Server name</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the |
| ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not |
| set, the default is the local system - either "localhost" or a domain socket |
| path.<br> |
| <br> |
| The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 |
| address, or a domain socket pathname.<br> |
| <br> |
| Note: The current server is tracked separately for each thread in a program. |
| Multi-threaded programs that override the server via the |
| <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same |
| server to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> |
| <p class="description">Set the client certificate callback.</p> |
| <p class="code"> |
| void cupsSetClientCertCB(<a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>cb</th> |
| <td class="description">Callback function</td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data pointer</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
| <br> |
| Note: The current certificate callback is tracked separately for each thread |
| in a program. Multi-threaded programs that override the callback need to do |
| so in each thread for the same callback to be used. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetCredentials">cupsSetCredentials</a></h3> |
| <p class="description">Set the default credentials to be used for SSL/TLS |
| connections.</p> |
| <p class="code"> |
| int cupsSetCredentials(cups_array_t *credentials);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Array of credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Note: The default credentials are tracked separately for each thread in a |
| program. Multi-threaded programs that override the setting need to do so in |
| each thread for the same setting to be used. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> |
| <p class="description">Set the default destination.</p> |
| <p class="code"> |
| void cupsSetDefaultDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Destination name</td></tr> |
| <tr><th>instance</th> |
| <td class="description">Instance name or <code>NULL</code></td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsSetDests2">cupsSetDests2</a></h3> |
| <p class="description">Save the list of destinations for the specified server.</p> |
| <p class="code"> |
| int cupsSetDests2(<a href="#http_t">http_t</a> *http, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| <tr><th>num_dests</th> |
| <td class="description">Number of destinations</td></tr> |
| <tr><th>dests</th> |
| <td class="description">Destinations</td></tr> |
| </tbody></table> |
| <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 saves the destinations to /etc/cups/lpoptions when run |
| as root and ~/.cups/lpoptions when run as a normal user. |
| |
| </p> |
| <h3 class="function"><a id="cupsSetEncryption">cupsSetEncryption</a></h3> |
| <p class="description">Set the encryption preference.</p> |
| <p class="code"> |
| void cupsSetEncryption(<a href="#http_encryption_t">http_encryption_t</a> e);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>e</th> |
| <td class="description">New encryption preference</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION |
| environment variable, then the ~/.cups/client.conf file, and finally the |
| /etc/cups/client.conf file. If not set, the default is |
| <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> |
| <br> |
| Note: The current encryption setting is tracked separately for each thread |
| in a program. Multi-threaded programs that override the setting need to do |
| so in each thread for the same setting to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> |
| <p class="description">Set the advanced password callback for CUPS.</p> |
| <p class="code"> |
| void cupsSetPasswordCB2(<a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>cb</th> |
| <td class="description">Callback function</td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data pointer</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which |
| reads the password from the console. Programs should call either this |
| function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered |
| by a program per thread.<br> |
| <br> |
| Note: The current password callback is tracked separately for each thread |
| in a program. Multi-threaded programs that override the callback need to do |
| so in each thread for the same callback to be used. |
| |
| </p> |
| <h3 class="function"><a id="cupsSetServer">cupsSetServer</a></h3> |
| <p class="description">Set the default server name and port.</p> |
| <p class="code"> |
| void cupsSetServer(const char *server);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>server</th> |
| <td class="description">Server name</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The "server" string can be a fully-qualified hostname, a numeric |
| IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP |
| addresses can be optionally followed by a colon and port number to override |
| the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to restore the |
| default server name and port.<br> |
| <br> |
| Note: The current server is tracked separately for each thread in a program. |
| Multi-threaded programs that override the server need to do so in each |
| thread for the same server to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> |
| <p class="description">Set the server certificate callback.</p> |
| <p class="code"> |
| void cupsSetServerCertCB(<a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>cb</th> |
| <td class="description">Callback function</td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data pointer</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
| <br> |
| Note: The current credentials callback is tracked separately for each thread |
| in a program. Multi-threaded programs that override the callback need to do |
| so in each thread for the same callback to be used. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsSetServerCredentials">cupsSetServerCredentials</a></h3> |
| <p class="description">Set the default server credentials.</p> |
| <p class="code"> |
| int cupsSetServerCredentials(const char *path, const char *common_name, int auto_create);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>path</th> |
| <td class="description">Keychain path or <code>NULL</code> for default</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Default common name for server</td></tr> |
| <tr><th>auto_create</th> |
| <td class="description">1 = automatically create self-signed certificates</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Note: The server credentials are used by all threads in the running process. |
| This function is threadsafe. |
| |
| </p> |
| <h3 class="function"><a id="cupsSetUser">cupsSetUser</a></h3> |
| <p class="description">Set the default user name.</p> |
| <p class="code"> |
| void cupsSetUser(const char *user);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>user</th> |
| <td class="description">User name</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Pass <code>NULL</code> to restore the default user name.<br> |
| <br> |
| Note: The current user name is tracked separately for each thread in a |
| program. Multi-threaded programs that override the user name need to do so |
| in each thread for the same user name to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsSetUserAgent">cupsSetUserAgent</a></h3> |
| <p class="description">Set the default HTTP User-Agent string.</p> |
| <p class="code"> |
| void cupsSetUserAgent(const char *user_agent);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>user_agent</th> |
| <td class="description">User-Agent string or <code>NULL</code></td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Setting the string to NULL forces the default value containing the CUPS |
| version, IPP version, and operating system version and architecture. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsStartDestDocument">cupsStartDestDocument</a></h3> |
| <p class="description">Start a new document.</p> |
| <p class="code"> |
| http_status_t cupsStartDestDocument(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id, const char *docname, const char *format, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, int last_document);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to destination</td></tr> |
| <tr><th>dest</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>info</th> |
| <td class="description">Destination information</td></tr> |
| <tr><th>job_id</th> |
| <td class="description">Job ID</td></tr> |
| <tr><th>docname</th> |
| <td class="description">Document name</td></tr> |
| <tr><th>format</th> |
| <td class="description">Document format</td></tr> |
| <tr><th>num_options</th> |
| <td class="description">Number of document options</td></tr> |
| <tr><th>options</th> |
| <td class="description">Document options</td></tr> |
| <tr><th>last_document</th> |
| <td class="description">1 if this is the last document</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of document creation</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name |
| of the document/file being printed, "format" is the MIME media type for the |
| document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" |
| are the options do be applied to the document. "last_document" should be 1 |
| if this is the last document to be submitted in the job. Returns |
| <code>HTTP_CONTINUE</code> on success. |
| |
| </p> |
| <h3 class="function"><a id="cupsUser">cupsUser</a></h3> |
| <p class="description">Return the current user's name.</p> |
| <p class="code"> |
| const char *cupsUser(void);</p> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">User name</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Note: The current user name is tracked separately for each thread in a |
| program. Multi-threaded programs that override the user name with the |
| <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user |
| name to be used.</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsUserAgent">cupsUserAgent</a></h3> |
| <p class="description">Return the default HTTP User-Agent string.</p> |
| <p class="code"> |
| const char *cupsUserAgent(void);</p> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">User-Agent string</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAcceptConnection">httpAcceptConnection</a></h3> |
| <p class="description">Accept a new HTTP client connection from the |
| specified listening socket.</p> |
| <p class="code"> |
| <a href="#http_t">http_t</a> *httpAcceptConnection(int fd, int blocking);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>fd</th> |
| <td class="description">Listen socket file descriptor</td></tr> |
| <tr><th>blocking</th> |
| <td class="description">1 if the connection should be |
| blocking, 0 otherwise</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">HTTP connection or <code>NULL</code></p> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpAddCredential">httpAddCredential</a></h3> |
| <p class="description">Allocates and adds a single credential to an array.</p> |
| <p class="code"> |
| int httpAddCredential(cups_array_t *credentials, const void *data, size_t datalen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Credentials array</td></tr> |
| <tr><th>data</th> |
| <td class="description">PEM-encoded X.509 data</td></tr> |
| <tr><th>datalen</th> |
| <td class="description">Length of data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">0 on success, -1 on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrAny">httpAddrAny</a></h3> |
| <p class="description">Check for the "any" address.</p> |
| <p class="code"> |
| int httpAddrAny(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address to check</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if "any", 0 otherwise</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpAddrClose">httpAddrClose</a></h3> |
| <p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or |
| <a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p> |
| <p class="code"> |
| int httpAddrClose(<a href="#http_addr_t">http_addr_t</a> *addr, int fd);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Listen address or <code>NULL</code></td></tr> |
| <tr><th>fd</th> |
| <td class="description">Socket file descriptor</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">0 on success, -1 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect2"><code>httpAddrConnect2</code></a> and the |
| listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>. This function |
| ensures that domain sockets are removed when closed. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrConnect2">httpAddrConnect2</a></h3> |
| <p class="description">Connect to any of the addresses in the list with a |
| timeout and optional cancel.</p> |
| <p class="code"> |
| <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrConnect2(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int *sock, int msec, int *cancel);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addrlist</th> |
| <td class="description">List of potential addresses</td></tr> |
| <tr><th>sock</th> |
| <td class="description">Socket</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Timeout in milliseconds</td></tr> |
| <tr><th>cancel</th> |
| <td class="description">Pointer to "cancel" variable</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Connected address or NULL on failure</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrCopyList">httpAddrCopyList</a></h3> |
| <p class="description">Copy an address list.</p> |
| <p class="code"> |
| <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrCopyList(<a href="#http_addrlist_t">http_addrlist_t</a> *src);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>src</th> |
| <td class="description">Source address list</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New address list or <code>NULL</code> on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrEqual">httpAddrEqual</a></h3> |
| <p class="description">Compare two addresses.</p> |
| <p class="code"> |
| int httpAddrEqual(const <a href="#http_addr_t">http_addr_t</a> *addr1, const <a href="#http_addr_t">http_addr_t</a> *addr2);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr1</th> |
| <td class="description">First address</td></tr> |
| <tr><th>addr2</th> |
| <td class="description">Second address</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if equal, 0 if not</p> |
| <h3 class="function"><a id="httpAddrFamily">httpAddrFamily</a></h3> |
| <p class="description">Get the address family of an address.</p> |
| <p class="code"> |
| int httpAddrFamily(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Address family</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrFreeList">httpAddrFreeList</a></h3> |
| <p class="description">Free an address list.</p> |
| <p class="code"> |
| void httpAddrFreeList(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addrlist</th> |
| <td class="description">Address list to free</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrGetList">httpAddrGetList</a></h3> |
| <p class="description">Get a list of addresses for a hostname.</p> |
| <p class="code"> |
| <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrGetList(const char *hostname, int family, const char *service);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>hostname</th> |
| <td class="description">Hostname, IP address, or NULL for passive listen address</td></tr> |
| <tr><th>family</th> |
| <td class="description">Address family or AF_UNSPEC</td></tr> |
| <tr><th>service</th> |
| <td class="description">Service name or port number</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">List of addresses or NULL</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLength">httpAddrLength</a></h3> |
| <p class="description">Return the length of the address in bytes.</p> |
| <p class="code"> |
| int httpAddrLength(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Length in bytes</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrListen">httpAddrListen</a></h3> |
| <p class="description">Create a listening socket bound to the specified |
| address and port.</p> |
| <p class="code"> |
| int httpAddrListen(<a href="#http_addr_t">http_addr_t</a> *addr, int port);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address to bind to</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number to bind to</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Socket or -1 on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLocalhost">httpAddrLocalhost</a></h3> |
| <p class="description">Check for the local loopback address.</p> |
| <p class="code"> |
| int httpAddrLocalhost(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address to check</td></tr> |
| </tbody></table> |
| <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/macOS 10.5 </span><a id="httpAddrLookup">httpAddrLookup</a></h3> |
| <p class="description">Lookup the hostname associated with the address.</p> |
| <p class="code"> |
| char *httpAddrLookup(const <a href="#http_addr_t">http_addr_t</a> *addr, char *name, int namelen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address to lookup</td></tr> |
| <tr><th>name</th> |
| <td class="description">Host name buffer</td></tr> |
| <tr><th>namelen</th> |
| <td class="description">Size of name buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Host name</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrPort">httpAddrPort</a></h3> |
| <p class="description">Get the port number associated with an address.</p> |
| <p class="code"> |
| int httpAddrPort(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Port number</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrString">httpAddrString</a></h3> |
| <p class="description">Convert an address to a numeric string.</p> |
| <p class="code"> |
| char *httpAddrString(const <a href="#http_addr_t">http_addr_t</a> *addr, char *s, int slen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>addr</th> |
| <td class="description">Address to convert</td></tr> |
| <tr><th>s</th> |
| <td class="description">String buffer</td></tr> |
| <tr><th>slen</th> |
| <td class="description">Length of string</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Numeric address string</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURI">httpAssembleURI</a></h3> |
| <p class="description">Assemble a uniform resource identifier from its |
| components.</p> |
| <p class="code"> |
| <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resource);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>encoding</th> |
| <td class="description">Encoding flags</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI buffer</td></tr> |
| <tr><th>urilen</th> |
| <td class="description">Size of URI buffer</td></tr> |
| <tr><th>scheme</th> |
| <td class="description">Scheme name</td></tr> |
| <tr><th>username</th> |
| <td class="description">Username</td></tr> |
| <tr><th>host</th> |
| <td class="description">Hostname or address</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number</td></tr> |
| <tr><th>resource</th> |
| <td class="description">Resource</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">URI status</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function escapes reserved characters in the URI depending on the |
| value of the "encoding" argument. You should use this function in |
| place of traditional string functions whenever you need to create a |
| URI string. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURIf">httpAssembleURIf</a></h3> |
| <p class="description">Assemble a uniform resource identifier from its |
| components with a formatted resource.</p> |
| <p class="code"> |
| <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resourcef, ...);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>encoding</th> |
| <td class="description">Encoding flags</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI buffer</td></tr> |
| <tr><th>urilen</th> |
| <td class="description">Size of URI buffer</td></tr> |
| <tr><th>scheme</th> |
| <td class="description">Scheme name</td></tr> |
| <tr><th>username</th> |
| <td class="description">Username</td></tr> |
| <tr><th>host</th> |
| <td class="description">Hostname or address</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number</td></tr> |
| <tr><th>resourcef</th> |
| <td class="description">Printf-style resource</td></tr> |
| <tr><th>...</th> |
| <td class="description">Additional arguments as needed</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">URI status</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function creates a formatted version of the resource string |
| argument "resourcef" and escapes reserved characters in the URI |
| depending on the value of the "encoding" argument. You should use |
| this function in place of traditional string functions whenever |
| you need to create a URI string. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAssembleUUID">httpAssembleUUID</a></h3> |
| <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p> |
| <p class="code"> |
| char *httpAssembleUUID(const char *server, int port, const char *name, int number, char *buffer, size_t bufsize);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>server</th> |
| <td class="description">Server name</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number</td></tr> |
| <tr><th>name</th> |
| <td class="description">Object name or NULL</td></tr> |
| <tr><th>number</th> |
| <td class="description">Object number or 0</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">String buffer</td></tr> |
| <tr><th>bufsize</th> |
| <td class="description">Size of buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">UUID string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function creates a unique 128-bit identifying number using the server |
| name, port number, random data, and optionally an object name and/or object |
| number. The result is formatted as a UUID URN as defined in RFC 4122.<br> |
| <br> |
| The buffer needs to be at least 46 bytes in size. |
| |
| </p> |
| <h3 class="function"><a id="httpBlocking">httpBlocking</a></h3> |
| <p class="description">Set blocking/non-blocking behavior on a connection.</p> |
| <p class="code"> |
| void httpBlocking(<a href="#http_t">http_t</a> *http, int b);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>b</th> |
| <td class="description">1 = blocking, 0 = non-blocking</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="httpCheck">httpCheck</a></h3> |
| <p class="description">Check to see if there is a pending response from the server.</p> |
| <p class="code"> |
| int httpCheck(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <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/macOS 10.3 </span><a id="httpClearCookie">httpClearCookie</a></h3> |
| <p class="description">Clear the cookie value(s).</p> |
| <p class="code"> |
| void httpClearCookie(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="httpClearFields">httpClearFields</a></h3> |
| <p class="description">Clear HTTP request fields.</p> |
| <p class="code"> |
| void httpClearFields(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="httpClose">httpClose</a></h3> |
| <p class="description">Close an HTTP connection.</p> |
| <p class="code"> |
| void httpClose(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpCompareCredentials">httpCompareCredentials</a></h3> |
| <p class="description">Compare two sets of X.509 credentials.</p> |
| <p class="code"> |
| int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>cred1</th> |
| <td class="description">First set of X.509 credentials</td></tr> |
| <tr><th>cred2</th> |
| <td class="description">Second set of X.509 credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if they match, 0 if they do not</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpConnect2">httpConnect2</a></h3> |
| <p class="description">Connect to a HTTP server.</p> |
| <p class="code"> |
| <a href="#http_t">http_t</a> *httpConnect2(const char *host, int port, <a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int family, <a href="#http_encryption_t">http_encryption_t</a> encryption, int blocking, int msec, int *cancel);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>host</th> |
| <td class="description">Host to connect to</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number</td></tr> |
| <tr><th>addrlist</th> |
| <td class="description">List of addresses or <code>NULL</code> to lookup</td></tr> |
| <tr><th>family</th> |
| <td class="description">Address family to use or <code>AF_UNSPEC</code> for any</td></tr> |
| <tr><th>encryption</th> |
| <td class="description">Type of encryption to use</td></tr> |
| <tr><th>blocking</th> |
| <td class="description">1 for blocking connection, 0 for non-blocking</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Connection timeout in milliseconds, 0 means don't connect</td></tr> |
| <tr><th>cancel</th> |
| <td class="description">Pointer to "cancel" variable</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New HTTP connection</p> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpCopyCredentials">httpCopyCredentials</a></h3> |
| <p class="description">Copy the credentials associated with the peer in |
| an encrypted connection.</p> |
| <p class="code"> |
| int httpCopyCredentials(<a href="#http_t">http_t</a> *http, cups_array_t **credentials);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection to server</td></tr> |
| <tr><th>credentials</th> |
| <td class="description">Array of credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></h3> |
| <p class="description">Return whether the credentials are valid for the given name.</p> |
| <p class="code"> |
| int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Name to check</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if valid, 0 otherwise</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></h3> |
| <p class="description">Return the expiration date of the credentials.</p> |
| <p class="code"> |
| time_t httpCredentialsGetExpiration(cups_array_t *credentials);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Expiration date of credentials</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetTrust">httpCredentialsGetTrust</a></h3> |
| <p class="description">Return the trust of credentials.</p> |
| <p class="code"> |
| <a href="#http_trust_t">http_trust_t</a> httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Common name for trust lookup</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Level of trust</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsString">httpCredentialsString</a></h3> |
| <p class="description">Return a string representing the credentials.</p> |
| <p class="code"> |
| size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">Buffer or <code>NULL</code></td></tr> |
| <tr><th>bufsize</th> |
| <td class="description">Size of buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Total size of credentials string</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpDecode64_2">httpDecode64_2</a></h3> |
| <p class="description">Base64-decode a string.</p> |
| <p class="code"> |
| char *httpDecode64_2(char *out, int *outlen, const char *in);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>out</th> |
| <td class="description">String to write to</td></tr> |
| <tr><th>outlen</th> |
| <td class="description">Size of output string</td></tr> |
| <tr><th>in</th> |
| <td class="description">String to read from</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Decoded string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The caller must initialize "outlen" to the maximum size of the decoded |
| string before calling <code>httpDecode64_2</code>. On return "outlen" contains the |
| decoded length of the string. |
| |
| </p> |
| <h3 class="function"><a id="httpDelete">httpDelete</a></h3> |
| <p class="description">Send a DELETE request to the server.</p> |
| <p class="code"> |
| int httpDelete(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI to delete</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpEncode64_2">httpEncode64_2</a></h3> |
| <p class="description">Base64-encode a string.</p> |
| <p class="code"> |
| char *httpEncode64_2(char *out, int outlen, const char *in, int inlen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>out</th> |
| <td class="description">String to write to</td></tr> |
| <tr><th>outlen</th> |
| <td class="description">Maximum size of output string</td></tr> |
| <tr><th>in</th> |
| <td class="description">String to read from</td></tr> |
| <tr><th>inlen</th> |
| <td class="description">Size of input string</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Encoded string</p> |
| <h3 class="function"><a id="httpEncryption">httpEncryption</a></h3> |
| <p class="description">Set the required encryption on the link.</p> |
| <p class="code"> |
| int httpEncryption(<a href="#http_t">http_t</a> *http, <a href="#http_encryption_t">http_encryption_t</a> e);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>e</th> |
| <td class="description">New encryption preference</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">-1 on error, 0 on success</p> |
| <h3 class="function"><a id="httpError">httpError</a></h3> |
| <p class="description">Get the last error on a connection.</p> |
| <p class="code"> |
| int httpError(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Error code (errno) value</p> |
| <h3 class="function"><a id="httpFieldValue">httpFieldValue</a></h3> |
| <p class="description">Return the HTTP field enumeration value for a field |
| name.</p> |
| <p class="code"> |
| <a href="#http_field_t">http_field_t</a> httpFieldValue(const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">String name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Field index</p> |
| <h3 class="function"><a id="httpFlush">httpFlush</a></h3> |
| <p class="description">Flush data read from a HTTP connection.</p> |
| <p class="code"> |
| void httpFlush(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpFlushWrite">httpFlushWrite</a></h3> |
| <p class="description">Flush data written to a HTTP connection.</p> |
| <p class="code"> |
| int httpFlushWrite(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Bytes written or -1 on error</p> |
| <h3 class="function"><a id="httpFreeCredentials">httpFreeCredentials</a></h3> |
| <p class="description">Free an array of credentials.</p> |
| <p class="code"> |
| void httpFreeCredentials(cups_array_t *credentials);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>credentials</th> |
| <td class="description">Array of credentials</td></tr> |
| </tbody></table> |
| <h3 class="function"><a id="httpGet">httpGet</a></h3> |
| <p class="description">Send a GET request to the server.</p> |
| <p class="code"> |
| int httpGet(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI to get</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetActivity">httpGetActivity</a></h3> |
| <p class="description">Get the most recent activity for a connection.</p> |
| <p class="code"> |
| time_t httpGetActivity(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Time of last read or write</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The return value is the time in seconds of the last read or write. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetAddress">httpGetAddress</a></h3> |
| <p class="description">Get the address of the connected peer of a connection.</p> |
| <p class="code"> |
| <a href="#http_addr_t">http_addr_t</a> *httpGetAddress(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Connected address or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">For connections created with <a href="#httpConnect2"><code>httpConnect2</code></a>, the address is for the |
| server. For connections created with <a href="#httpAccept"><code>httpAccept</code></a>, the address is for |
| the client.<br> |
| <br> |
| Returns <code>NULL</code> if the socket is currently unconnected. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpGetAuthString">httpGetAuthString</a></h3> |
| <p class="description">Get the current authorization string.</p> |
| <p class="code"> |
| char *httpGetAuthString(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Authorization string</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The authorization string is set by <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> and |
| <a href="#httpSetAuthString"><code>httpSetAuthString</code></a>. Use <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> to retrieve the |
| string to use with <a href="#httpSetField"><code>httpSetField</code></a> for the |
| <code>HTTP_FIELD_AUTHORIZATION</code> value. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetBlocking">httpGetBlocking</a></h3> |
| <p class="description">Get the blocking/non-block state of a connection.</p> |
| <p class="code"> |
| int httpGetBlocking(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <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.7/macOS 10.9 </span><a id="httpGetContentEncoding">httpGetContentEncoding</a></h3> |
| <p class="description">Get a common content encoding, if any, between |
| the client and server.</p> |
| <p class="code"> |
| const char *httpGetContentEncoding(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Content-Coding value or |
| <code>NULL</code> for the identity |
| coding.</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be |
| called after receiving a response from the server or a request from the |
| client. The value returned can be use in subsequent requests (for clients) |
| or in the response (for servers) in order to compress the content stream. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpGetCookie">httpGetCookie</a></h3> |
| <p class="description">Get any cookie data from the response.</p> |
| <p class="code"> |
| const char *httpGetCookie(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Cookie data or <code>NULL</code></p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetDateString2">httpGetDateString2</a></h3> |
| <p class="description">Get a formatted date/time string from a time value.</p> |
| <p class="code"> |
| const char *httpGetDateString2(time_t t, char *s, int slen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>t</th> |
| <td class="description">Time in seconds</td></tr> |
| <tr><th>s</th> |
| <td class="description">String buffer</td></tr> |
| <tr><th>slen</th> |
| <td class="description">Size of string buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Date/time string</p> |
| <h3 class="function"><a id="httpGetDateTime">httpGetDateTime</a></h3> |
| <p class="description">Get a time value from a formatted date/time string.</p> |
| <p class="code"> |
| time_t httpGetDateTime(const char *s);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>s</th> |
| <td class="description">Date/time string</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Time in seconds</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetEncryption">httpGetEncryption</a></h3> |
| <p class="description">Get the current encryption mode of a connection.</p> |
| <p class="code"> |
| <a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current encryption mode</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function returns the encryption mode for the connection. Use the |
| <a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has |
| been established. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpGetExpect">httpGetExpect</a></h3> |
| <p class="description">Get the value of the Expect header, if any.</p> |
| <p class="code"> |
| http_status_t httpGetExpect(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Expect: status, if any</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise |
| returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetFd">httpGetFd</a></h3> |
| <p class="description">Get the file descriptor associated with a connection.</p> |
| <p class="code"> |
| int httpGetFd(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">File descriptor or -1 if none</p> |
| <h3 class="function"><a id="httpGetField">httpGetField</a></h3> |
| <p class="description">Get a field value from a request/response.</p> |
| <p class="code"> |
| const char *httpGetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>field</th> |
| <td class="description">Field to get</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Field value</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetHostname">httpGetHostname</a></h3> |
| <p class="description">Get the FQDN for the connection or local system.</p> |
| <p class="code"> |
| const char *httpGetHostname(<a href="#http_t">http_t</a> *http, char *s, int slen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection or NULL</td></tr> |
| <tr><th>s</th> |
| <td class="description">String buffer for name</td></tr> |
| <tr><th>slen</th> |
| <td class="description">Size of buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">FQDN for connection or system</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">When "http" points to a connected socket, return the hostname or |
| address that was used in the call to httpConnect() or httpConnectEncrypt(), |
| or the address of the client for the connection from httpAcceptConnection(). |
| Otherwise, return the FQDN for the local system using both gethostname() |
| and gethostbyname() to get the local hostname with domain. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetKeepAlive">httpGetKeepAlive</a></h3> |
| <p class="description">Get the current Keep-Alive state of the connection.</p> |
| <p class="code"> |
| <a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Keep-Alive state</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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"> |
| off_t httpGetLength2(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Content length</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function returns the complete content length, even for |
| content larger than 2^31 - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetPending">httpGetPending</a></h3> |
| <p class="description">Get the number of bytes that are buffered for writing.</p> |
| <p class="code"> |
| size_t httpGetPending(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes buffered</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetReady">httpGetReady</a></h3> |
| <p class="description">Get the number of bytes that can be read without blocking.</p> |
| <p class="code"> |
| size_t httpGetReady(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes available</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetRemaining">httpGetRemaining</a></h3> |
| <p class="description">Get the number of remaining bytes in the message |
| body or current chunk.</p> |
| <p class="code"> |
| size_t httpGetRemaining(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Remaining bytes</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the |
| message body is chunked or fixed-length. |
| |
| </p> |
| <h3 class="function"><a id="httpGetState">httpGetState</a></h3> |
| <p class="description">Get the current state of the HTTP request.</p> |
| <p class="code"> |
| <a href="#http_state_t">http_state_t</a> httpGetState(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">HTTP state</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetStatus">httpGetStatus</a></h3> |
| <p class="description">Get the status of the last HTTP request.</p> |
| <p class="code"> |
| http_status_t httpGetStatus(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">HTTP status</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetSubField2">httpGetSubField2</a></h3> |
| <p class="description">Get a sub-field value.</p> |
| <p class="code"> |
| char *httpGetSubField2(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *name, char *value, int valuelen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>field</th> |
| <td class="description">Field index</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of sub-field</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value string</td></tr> |
| <tr><th>valuelen</th> |
| <td class="description">Size of value buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Value or <code>NULL</code></p> |
| <h3 class="function"><a id="httpGetVersion">httpGetVersion</a></h3> |
| <p class="description">Get the HTTP version at the other end.</p> |
| <p class="code"> |
| <a href="#http_version_t">http_version_t</a> httpGetVersion(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Version number</p> |
| <h3 class="function"><a id="httpGets">httpGets</a></h3> |
| <p class="description">Get a line of text from a HTTP connection.</p> |
| <p class="code"> |
| char *httpGets(char *line, int length, <a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>line</th> |
| <td class="description">Line to read into</td></tr> |
| <tr><th>length</th> |
| <td class="description">Max length of buffer</td></tr> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Line or <code>NULL</code></p> |
| <h3 class="function"><a id="httpHead">httpHead</a></h3> |
| <p class="description">Send a HEAD request to the server.</p> |
| <p class="code"> |
| int httpHead(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI for head</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><a id="httpInitialize">httpInitialize</a></h3> |
| <p class="description">Initialize the HTTP interface library and set the |
| default HTTP proxy (if any).</p> |
| <p class="code"> |
| void httpInitialize(void);</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsChunked">httpIsChunked</a></h3> |
| <p class="description">Report whether a message body is chunked.</p> |
| <p class="code"> |
| int httpIsChunked(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if chunked, 0 if not</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function returns non-zero if the message body is composed of |
| variable-length chunks. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsEncrypted">httpIsEncrypted</a></h3> |
| <p class="description">Report whether a connection is encrypted.</p> |
| <p class="code"> |
| int httpIsEncrypted(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if encrypted, 0 if not</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function returns non-zero if the connection is currently encrypted. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpLoadCredentials">httpLoadCredentials</a></h3> |
| <p class="description">Load X.509 credentials from a keychain file.</p> |
| <p class="code"> |
| int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>path</th> |
| <td class="description">Keychain path or <code>NULL</code> for default</td></tr> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Common name for credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">0 on success, -1 on error</p> |
| <h3 class="function"><a id="httpOptions">httpOptions</a></h3> |
| <p class="description">Send an OPTIONS request to the server.</p> |
| <p class="code"> |
| int httpOptions(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI for options</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpPeek">httpPeek</a></h3> |
| <p class="description">Peek at data from a HTTP connection.</p> |
| <p class="code"> |
| ssize_t httpPeek(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">Buffer for data</td></tr> |
| <tr><th>length</th> |
| <td class="description">Maximum number of bytes</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes copied</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function copies available data from the given HTTP connection, reading |
| a buffer as needed. The data is still available for reading using |
| <a href="#httpRead2"><code>httpRead2</code></a>.<br> |
| <br> |
| For non-blocking connections the usual timeouts apply. |
| |
| </p> |
| <h3 class="function"><a id="httpPost">httpPost</a></h3> |
| <p class="description">Send a POST request to the server.</p> |
| <p class="code"> |
| int httpPost(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI for post</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><a id="httpPut">httpPut</a></h3> |
| <p class="description">Send a PUT request to the server.</p> |
| <p class="code"> |
| int httpPut(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI to put</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpRead2">httpRead2</a></h3> |
| <p class="description">Read data from a HTTP connection.</p> |
| <p class="code"> |
| ssize_t httpRead2(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">Buffer for data</td></tr> |
| <tr><th>length</th> |
| <td class="description">Maximum number of bytes</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes read</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpReadRequest">httpReadRequest</a></h3> |
| <p class="description">Read a HTTP request from a connection.</p> |
| <p class="code"> |
| <a href="#http_state_t">http_state_t</a> httpReadRequest(<a href="#http_t">http_t</a> *http, char *uri, size_t urilen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>uri</th> |
| <td class="description">URI buffer</td></tr> |
| <tr><th>urilen</th> |
| <td class="description">Size of URI buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New state of connection</p> |
| <h3 class="function"><a id="httpReconnect2">httpReconnect2</a></h3> |
| <p class="description">Reconnect to a HTTP server with timeout and optional |
| cancel.</p> |
| <p class="code"> |
| int httpReconnect2(<a href="#http_t">http_t</a> *http, int msec, int *cancel);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Timeout in milliseconds</td></tr> |
| <tr><th>cancel</th> |
| <td class="description">Pointer to "cancel" variable</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">0 on success, non-zero on failure</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpResolveHostname">httpResolveHostname</a></h3> |
| <p class="description">Resolve the hostname of the HTTP connection |
| address.</p> |
| <p class="code"> |
| const char *httpResolveHostname(<a href="#http_t">http_t</a> *http, char *buffer, size_t bufsize);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">Hostname buffer</td></tr> |
| <tr><th>bufsize</th> |
| <td class="description">Size of buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Resolved hostname or <code>NULL</code></p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSaveCredentials">httpSaveCredentials</a></h3> |
| <p class="description">Save X.509 credentials to a keychain file.</p> |
| <p class="code"> |
| int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>path</th> |
| <td class="description">Keychain path or <code>NULL</code> for default</td></tr> |
| <tr><th>credentials</th> |
| <td class="description">Credentials</td></tr> |
| <tr><th>common_name</th> |
| <td class="description">Common name for credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">-1 on error, 0 on success</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSeparateURI">httpSeparateURI</a></h3> |
| <p class="description">Separate a Universal Resource Identifier into its |
| components.</p> |
| <p class="code"> |
| <a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> decoding, const char *uri, char *scheme, int schemelen, char *username, int usernamelen, char *host, int hostlen, int *port, char *resource, int resourcelen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>decoding</th> |
| <td class="description">Decoding flags</td></tr> |
| <tr><th>uri</th> |
| <td class="description">Universal Resource Identifier</td></tr> |
| <tr><th>scheme</th> |
| <td class="description">Scheme (http, https, etc.)</td></tr> |
| <tr><th>schemelen</th> |
| <td class="description">Size of scheme buffer</td></tr> |
| <tr><th>username</th> |
| <td class="description">Username</td></tr> |
| <tr><th>usernamelen</th> |
| <td class="description">Size of username buffer</td></tr> |
| <tr><th>host</th> |
| <td class="description">Hostname</td></tr> |
| <tr><th>hostlen</th> |
| <td class="description">Size of hostname buffer</td></tr> |
| <tr><th>port</th> |
| <td class="description">Port number to use</td></tr> |
| <tr><th>resource</th> |
| <td class="description">Resource/filename</td></tr> |
| <tr><th>resourcelen</th> |
| <td class="description">Size of resource buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Result of separation</p> |
| <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpSetAuthString">httpSetAuthString</a></h3> |
| <p class="description">Set the current authorization string.</p> |
| <p class="code"> |
| void httpSetAuthString(<a href="#http_t">http_t</a> *http, const char *scheme, const char *data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>scheme</th> |
| <td class="description">Auth scheme (NULL to clear it)</td></tr> |
| <tr><th>data</th> |
| <td class="description">Auth data (NULL for none)</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function just stores a copy of the current authorization string in |
| the HTTP connection object. You must still call <a href="#httpSetField"><code>httpSetField</code></a> to set |
| <code>HTTP_FIELD_AUTHORIZATION</code> prior to issuing a HTTP request using |
| <a href="#httpGet"><code>httpGet</code></a>, <a href="#httpHead"><code>httpHead</code></a>, <a href="#httpOptions"><code>httpOptions</code></a>, <a href="#httpPost"><code>httpPost</code></a>, or |
| <a href="#httpPut"><code>httpPut</code></a>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpSetCookie">httpSetCookie</a></h3> |
| <p class="description">Set the cookie value(s).</p> |
| <p class="code"> |
| void httpSetCookie(<a href="#http_t">http_t</a> *http, const char *cookie);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">Connection</td></tr> |
| <tr><th>cookie</th> |
| <td class="description">Cookie string</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetCredentials">httpSetCredentials</a></h3> |
| <p class="description">Set the credentials associated with an encrypted |
| connection.</p> |
| <p class="code"> |
| int httpSetCredentials(<a href="#http_t">http_t</a> *http, cups_array_t *credentials);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>credentials</th> |
| <td class="description">Array of credentials</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status of call (0 = success)</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpSetDefaultField">httpSetDefaultField</a></h3> |
| <p class="description">Set the default value of an HTTP header.</p> |
| <p class="code"> |
| void httpSetDefaultField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>field</th> |
| <td class="description">Field index</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>, |
| and <code>HTTP_FIELD_USER_AGENT</code> can be set. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetExpect">httpSetExpect</a></h3> |
| <p class="description">Set the Expect: header in a request.</p> |
| <p class="code"> |
| void httpSetExpect(<a href="#http_t">http_t</a> *http, http_status_t expect);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>expect</th> |
| <td class="description">HTTP status to expect |
| (<code>HTTP_STATUS_CONTINUE</code>)</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the "expect" |
| argument. |
| |
| </p> |
| <h3 class="function"><a id="httpSetField">httpSetField</a></h3> |
| <p class="description">Set the value of an HTTP header.</p> |
| <p class="code"> |
| void httpSetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>field</th> |
| <td class="description">Field index</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSetKeepAlive">httpSetKeepAlive</a></h3> |
| <p class="description">Set the current Keep-Alive state of a connection.</p> |
| <p class="code"> |
| void httpSetKeepAlive(<a href="#http_t">http_t</a> *http, <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>keep_alive</th> |
| <td class="description">New Keep-Alive value</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetLength">httpSetLength</a></h3> |
| <p class="description">Set the content-length and content-encoding.</p> |
| <p class="code"> |
| void httpSetLength(<a href="#http_t">http_t</a> *http, size_t length);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>length</th> |
| <td class="description">Length (0 for chunked)</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetTimeout">httpSetTimeout</a></h3> |
| <p class="description">Set read/write timeouts and an optional callback.</p> |
| <p class="code"> |
| void httpSetTimeout(<a href="#http_t">http_t</a> *http, double timeout, <a href="#http_timeout_cb_t">http_timeout_cb_t</a> cb, void *user_data);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>timeout</th> |
| <td class="description">Number of seconds for timeout, |
| must be greater than 0</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Callback function or <code>NULL</code></td></tr> |
| <tr><th>user_data</th> |
| <td class="description">User data pointer</td></tr> |
| </tbody></table> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The optional timeout callback receives both the HTTP connection and a user |
| data pointer and must return 1 to continue or 0 to error (time) out. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpShutdown">httpShutdown</a></h3> |
| <p class="description">Shutdown one side of an HTTP connection.</p> |
| <p class="code"> |
| void httpShutdown(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpStateString">httpStateString</a></h3> |
| <p class="description">Return the string describing a HTTP state value.</p> |
| <p class="code"> |
| const char *httpStateString(<a href="#http_state_t">http_state_t</a> state);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>state</th> |
| <td class="description">HTTP state value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">State string</p> |
| <h3 class="function"><a id="httpStatus">httpStatus</a></h3> |
| <p class="description">Return a short string describing a HTTP status code.</p> |
| <p class="code"> |
| const char *httpStatus(http_status_t status);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>status</th> |
| <td class="description">HTTP status code</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <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 7231.</p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpURIStatusString">httpURIStatusString</a></h3> |
| <p class="description">Return a string describing a URI status code.</p> |
| <p class="code"> |
| const char *httpURIStatusString(<a href="#http_uri_status_t">http_uri_status_t</a> status);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>status</th> |
| <td class="description">URI status code</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Localized status string</p> |
| <h3 class="function"><a id="httpUpdate">httpUpdate</a></h3> |
| <p class="description">Update the current HTTP state for incoming data.</p> |
| <p class="code"> |
| http_status_t httpUpdate(<a href="#http_t">http_t</a> *http);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">HTTP status</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpWait">httpWait</a></h3> |
| <p class="description">Wait for data available on a connection.</p> |
| <p class="code"> |
| int httpWait(<a href="#http_t">http_t</a> *http, int msec);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>msec</th> |
| <td class="description">Milliseconds to wait</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if data is available, 0 otherwise</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpWrite2">httpWrite2</a></h3> |
| <p class="description">Write data to a HTTP connection.</p> |
| <p class="code"> |
| ssize_t httpWrite2(<a href="#http_t">http_t</a> *http, const char *buffer, size_t length);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">Buffer for data</td></tr> |
| <tr><th>length</th> |
| <td class="description">Number of bytes to write</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes written</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpWriteResponse">httpWriteResponse</a></h3> |
| <p class="description">Write a HTTP response to a client connection.</p> |
| <p class="code"> |
| int httpWriteResponse(<a href="#http_t">http_t</a> *http, http_status_t status);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>status</th> |
| <td class="description">Status code</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">0 on success, -1 on error</p> |
| <h3 class="function"><a id="ippAddBoolean">ippAddBoolean</a></h3> |
| <p class="description">Add a boolean attribute to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, char value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value of attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><a id="ippAddBooleans">ippAddBooleans</a></h3> |
| <p class="description">Add an array of boolean values.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const char *values);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>values</th> |
| <td class="description">Values</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="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(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_t">ipp_t</a> *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="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(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const <a href="#ipp_t">ipp_t</a> **values);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>values</th> |
| <td class="description">Values</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| |
| </p> |
| <h3 class="function"><a id="ippAddDate">ippAddDate</a></h3> |
| <p class="description">Add a dateTime attribute to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><a id="ippAddInteger">ippAddInteger</a></h3> |
| <p class="description">Add a integer attribute to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddInteger(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value of attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer |
| (<code>IPP_TAG_INTEGER</code>).</p> |
| <h3 class="function"><a id="ippAddIntegers">ippAddIntegers</a></h3> |
| <p class="description">Add an array of integer values.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddIntegers(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const int *values);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>values</th> |
| <td class="description">Values</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer |
| (<code>IPP_TAG_INTEGER</code>).</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const void *data, int datalen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>data</th> |
| <td class="description">octetString data</td></tr> |
| <tr><th>datalen</th> |
| <td class="description">Length of data in bytes</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAddOutOfBand">ippAddOutOfBand</a></h3> |
| <p class="description">Add an out-of-band value to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOutOfBand(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported out-of-band values include unsupported-value |
| (<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown |
| (<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable |
| (<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and |
| admin-define (<code>IPP_TAG_ADMINDEFINE</code>). |
| |
| </p> |
| <h3 class="function"><a id="ippAddRange">ippAddRange</a></h3> |
| <p class="description">Add a range of values to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int lower, int upper);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>lower</th> |
| <td class="description">Lower value</td></tr> |
| <tr><th>upper</th> |
| <td class="description">Upper value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| The <code>lower</code> parameter must be less than or equal to the <code>upper</code> parameter.</p> |
| <h3 class="function"><a id="ippAddRanges">ippAddRanges</a></h3> |
| <p class="description">Add ranges of values to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const int *lower, const int *upper);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>lower</th> |
| <td class="description">Lower values</td></tr> |
| <tr><th>upper</th> |
| <td class="description">Upper values</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><a id="ippAddResolution">ippAddResolution</a></h3> |
| <p class="description">Add a resolution value to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_res_t">ipp_res_t</a> units, int xres, int yres);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>units</th> |
| <td class="description">Units for resolution</td></tr> |
| <tr><th>xres</th> |
| <td class="description">X resolution</td></tr> |
| <tr><th>yres</th> |
| <td class="description">Y resolution</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><a id="ippAddResolutions">ippAddResolutions</a></h3> |
| <p class="description">Add resolution values to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, <a href="#ipp_res_t">ipp_res_t</a> units, const int *xres, const int *yres);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>units</th> |
| <td class="description">Units for resolution</td></tr> |
| <tr><th>xres</th> |
| <td class="description">X resolutions</td></tr> |
| <tr><th>yres</th> |
| <td class="description">Y resolutions</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| <h3 class="function"><a id="ippAddSeparator">ippAddSeparator</a></h3> |
| <p class="description">Add a group separator to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.</p> |
| <h3 class="function"><a id="ippAddString">ippAddString</a></h3> |
| <p class="description">Add a language-encoded string to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>language</th> |
| <td class="description">Language code</td></tr> |
| <tr><th>value</th> |
| <td class="description">Value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage |
| (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme |
| (<code>IPP_TAG_URISCHEME</code>).<br> |
| <br> |
| The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and |
| textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringf">ippAddStringf</a></h3> |
| <p class="description">Add a formatted string to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringf(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, ...);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>language</th> |
| <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| <tr><th>format</th> |
| <td class="description">Printf-style format string</td></tr> |
| <tr><th>...</th> |
| <td class="description">Additional arguments as needed</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document |
| (<code>IPP_TAG_DOCUMENT</code>), event notification |
| (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), |
| printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), |
| or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage |
| (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme |
| (<code>IPP_TAG_URISCHEME</code>).<br> |
| <br> |
| The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage |
| and textWithLanguage string values and must be <code>NULL</code> for all other |
| string values.<br> |
| <br> |
| The <code>format</code> parameter uses formatting characters compatible with the |
| printf family of standard functions. Additional arguments follow it as |
| needed. The formatted string is truncated as needed to the maximum length of |
| the corresponding value type. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringfv">ippAddStringfv</a></h3> |
| <p class="description">Add a formatted string to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringfv(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, va_list ap);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>language</th> |
| <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| <tr><th>format</th> |
| <td class="description">Printf-style format string</td></tr> |
| <tr><th>ap</th> |
| <td class="description">Additional arguments</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document |
| (<code>IPP_TAG_DOCUMENT</code>), event notification |
| (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), |
| printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), |
| or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage |
| (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme |
| (<code>IPP_TAG_URISCHEME</code>).<br> |
| <br> |
| The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage |
| and textWithLanguage string values and must be <code>NULL</code> for all other |
| string values.<br> |
| <br> |
| The <code>format</code> parameter uses formatting characters compatible with the |
| printf family of standard functions. Additional arguments are passed in the |
| stdarg pointer <code>ap</code>. The formatted string is truncated as needed to the |
| maximum length of the corresponding value type. |
| |
| </p> |
| <h3 class="function"><a id="ippAddStrings">ippAddStrings</a></h3> |
| <p class="description">Add language-encoded strings to an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStrings(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const char *language, const char *const *values);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>group</th> |
| <td class="description">IPP group</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Type of attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>num_values</th> |
| <td class="description">Number of values</td></tr> |
| <tr><th>language</th> |
| <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| <tr><th>values</th> |
| <td class="description">Values</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| <br> |
| Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage |
| (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme |
| (<code>IPP_TAG_URISCHEME</code>).<br> |
| <br> |
| The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and |
| textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAttributeString">ippAttributeString</a></h3> |
| <p class="description">Convert the attribute's value to a string.</p> |
| <p class="code"> |
| size_t ippAttributeString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, char *buffer, size_t bufsize);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| <tr><th>buffer</th> |
| <td class="description">String buffer or NULL</td></tr> |
| <tr><th>bufsize</th> |
| <td class="description">Size of string buffer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of bytes less nul</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns the number of bytes that would be written, not including the |
| trailing nul. The buffer pointer can be NULL to get the required length, |
| just like (v)snprintf. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsInteger">ippContainsInteger</a></h3> |
| <p class="description">Determine whether an attribute contains the |
| specified value or is within the list of ranges.</p> |
| <p class="code"> |
| int ippContainsInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">Integer/enum value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on a match, 0 on no match</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns non-zero when the attribute contains either a matching integer or |
| enum value, or the value falls within one of the rangeOfInteger values for |
| the attribute. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsString">ippContainsString</a></h3> |
| <p class="description">Determine whether an attribute contains the |
| specified string value.</p> |
| <p class="code"> |
| int ippContainsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, const char *value);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| <tr><th>value</th> |
| <td class="description">String value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on a match, 0 on no match</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword, |
| naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttribute">ippCopyAttribute</a></h3> |
| <p class="description">Copy an attribute.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippCopyAttribute(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *srcattr, int quickcopy);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dst</th> |
| <td class="description">Destination IPP message</td></tr> |
| <tr><th>srcattr</th> |
| <td class="description">Attribute to copy</td></tr> |
| <tr><th>quickcopy</th> |
| <td class="description">1 for a referenced copy, 0 for normal</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">New attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message. |
| When <code>quickcopy</code> is non-zero, a "shallow" reference copy of the attribute is |
| created - this should only be done as long as the original source IPP message will |
| not be freed for the life of the destination. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttributes">ippCopyAttributes</a></h3> |
| <p class="description">Copy attributes from one IPP message to another.</p> |
| <p class="code"> |
| int ippCopyAttributes(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_t">ipp_t</a> *src, int quickcopy, <a href="#ipp_copycb_t">ipp_copycb_t</a> cb, void *context);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dst</th> |
| <td class="description">Destination IPP message</td></tr> |
| <tr><th>src</th> |
| <td class="description">Source IPP message</td></tr> |
| <tr><th>quickcopy</th> |
| <td class="description">1 for a referenced copy, 0 for normal</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Copy callback or <code>NULL</code> for none</td></tr> |
| <tr><th>context</th> |
| <td class="description">Context pointer</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Zero or more attributes are copied from the source IPP message, <code>src</code>, to the |
| destination IPP message, <code>dst</code>. When <code>quickcopy</code> is non-zero, a "shallow" |
| reference copy of the attribute is created - this should only be done as long as the |
| original source IPP message will not be freed for the life of the destination.<br> |
| <br> |
| The <code>cb</code> and <code>context</code> parameters provide a generic way to "filter" the |
| attributes that are copied - the function must return 1 to copy the attribute or |
| 0 to skip it. The function may also choose to do a partial copy of the source attribute |
| itself. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippCreateRequestedArray">ippCreateRequestedArray</a></h3> |
| <p class="description">Create a CUPS array of attribute names from the |
| given requested-attributes attribute.</p> |
| <p class="code"> |
| cups_array_t *ippCreateRequestedArray(<a href="#ipp_t">ipp_t</a> *request);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>request</th> |
| <td class="description">IPP request</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">CUPS array or <code>NULL</code> if all</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the |
| list of "requested-attribute" values supplied in an IPP request. All IANA- |
| registered values are supported in addition to the CUPS IPP extension |
| attributes.<br> |
| <br> |
| The <code>request</code> parameter specifies the request message that was read from |
| the client. |
| |
| <code>NULL</code> is returned if all attributes should be returned. Otherwise, the |
| result is a sorted array of attribute names, where <code>cupsArrayFind(array, |
| "attribute-name")</code> will return a non-NULL pointer. The array must be freed |
| using the <code>cupsArrayDelete</code> function. |
| |
| </p> |
| <h3 class="function"><a id="ippDateToTime">ippDateToTime</a></h3> |
| <p class="description">Convert from RFC 2579 Date/Time format to time in |
| seconds.</p> |
| <p class="code"> |
| time_t ippDateToTime(const <a href="#ipp_uchar_t">ipp_uchar_t</a> *date);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>date</th> |
| <td class="description">RFC 2579 date info</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">UNIX time value</p> |
| <h3 class="function"><a id="ippDelete">ippDelete</a></h3> |
| <p class="description">Delete an IPP message.</p> |
| <p class="code"> |
| void ippDelete(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippDeleteAttribute">ippDeleteAttribute</a></h3> |
| <p class="description">Delete a single attribute in an IPP message.</p> |
| <p class="code"> |
| void ippDeleteAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">Attribute to delete</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippDeleteValues">ippDeleteValues</a></h3> |
| <p class="description">Delete values in an attribute.</p> |
| <p class="code"> |
| int ippDeleteValues(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int count);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Index of first value to delete (0-based)</td></tr> |
| <tr><th>count</th> |
| <td class="description">Number of values to delete</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies the first value to delete, starting at |
| 0. It must be less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| Deleting all values in an attribute deletes the attribute. |
| |
| </p> |
| <h3 class="function"><a id="ippEnumString">ippEnumString</a></h3> |
| <p class="description">Return a string corresponding to the enum value.</p> |
| <p class="code"> |
| const char *ippEnumString(const char *attrname, int enumvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attrname</th> |
| <td class="description">Attribute name</td></tr> |
| <tr><th>enumvalue</th> |
| <td class="description">Enum value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Enum string</p> |
| <h3 class="function"><a id="ippEnumValue">ippEnumValue</a></h3> |
| <p class="description">Return the value associated with a given enum string.</p> |
| <p class="code"> |
| int ippEnumValue(const char *attrname, const char *enumstring);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attrname</th> |
| <td class="description">Attribute name</td></tr> |
| <tr><th>enumstring</th> |
| <td class="description">Enum string</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Enum value or -1 if unknown</p> |
| <h3 class="function"><a id="ippErrorString">ippErrorString</a></h3> |
| <p class="description">Return a name for the given status code.</p> |
| <p class="code"> |
| const char *ippErrorString(ipp_status_t error);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>error</th> |
| <td class="description">Error status</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Text string</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippErrorValue">ippErrorValue</a></h3> |
| <p class="description">Return a status code for the given name.</p> |
| <p class="code"> |
| ipp_status_t ippErrorValue(const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP status code</p> |
| <h3 class="function"><a id="ippFindAttribute">ippFindAttribute</a></h3> |
| <p class="description">Find a named attribute in a request.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>type</th> |
| <td class="description">Type of attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Matching attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list |
| of attribute and member names separated by slashes, for example |
| "media-col/media-size".</p> |
| <h3 class="function"><a id="ippFindNextAttribute">ippFindNextAttribute</a></h3> |
| <p class="description">Find the next named attribute in a request.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>name</th> |
| <td class="description">Name of attribute</td></tr> |
| <tr><th>type</th> |
| <td class="description">Type of attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Matching attribute</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list |
| of attribute and member names separated by slashes, for example |
| "media-col/media-size".</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippFirstAttribute">ippFirstAttribute</a></h3> |
| <p class="description">Return the first attribute in the message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFirstAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">First attribute or <code>NULL</code> if none</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetBoolean">ippGetBoolean</a></h3> |
| <p class="description">Get a boolean value for an attribute.</p> |
| <p class="code"> |
| int ippGetBoolean(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Boolean value or 0 on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCollection">ippGetCollection</a></h3> |
| <p class="description">Get a collection value for an attribute.</p> |
| <p class="code"> |
| <a href="#ipp_t">ipp_t</a> *ippGetCollection(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Collection value or <code>NULL</code> on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCount">ippGetCount</a></h3> |
| <p class="description">Get the number of values in an attribute.</p> |
| <p class="code"> |
| int ippGetCount(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Number of values or 0 on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetDate">ippGetDate</a></h3> |
| <p class="description">Get a dateTime value for an attribute.</p> |
| <p class="code"> |
| const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">dateTime value or <code>NULL</code></p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetGroupTag">ippGetGroupTag</a></h3> |
| <p class="description">Get the group associated with an attribute.</p> |
| <p class="code"> |
| ipp_tag_t ippGetGroupTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetInteger">ippGetInteger</a></h3> |
| <p class="description">Get the integer/enum value for an attribute.</p> |
| <p class="code"> |
| int ippGetInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Value or 0 on error</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetName">ippGetName</a></h3> |
| <p class="description">Get the attribute name.</p> |
| <p class="code"> |
| const char *ippGetName(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Attribute name or <code>NULL</code> for separators</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippGetOctetString">ippGetOctetString</a></h3> |
| <p class="description">Get an octetString value from an IPP attribute.</p> |
| <p class="code"> |
| void *ippGetOctetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *datalen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>datalen</th> |
| <td class="description">Length of octetString data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Pointer to octetString data</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetOperation">ippGetOperation</a></h3> |
| <p class="description">Get the operation ID in an IPP message.</p> |
| <p class="code"> |
| ipp_op_t ippGetOperation(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP request message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Operation ID or 0 on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRange">ippGetRange</a></h3> |
| <p class="description">Get a rangeOfInteger value from an attribute.</p> |
| <p class="code"> |
| int ippGetRange(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *uppervalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>uppervalue</th> |
| <td class="description">Upper value of range</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Lower value of range or 0</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRequestId">ippGetRequestId</a></h3> |
| <p class="description">Get the request ID from an IPP message.</p> |
| <p class="code"> |
| int ippGetRequestId(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Request ID or 0 on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetResolution">ippGetResolution</a></h3> |
| <p class="description">Get a resolution value for an attribute.</p> |
| <p class="code"> |
| int ippGetResolution(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *yres, <a href="#ipp_res_t">ipp_res_t</a> *units);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>yres</th> |
| <td class="description">Vertical/feed resolution</td></tr> |
| <tr><th>units</th> |
| <td class="description">Units for resolution</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Horizontal/cross feed resolution or 0</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetState">ippGetState</a></h3> |
| <p class="description">Get the IPP message state.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippGetState(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP message state value</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetStatusCode">ippGetStatusCode</a></h3> |
| <p class="description">Get the status code from an IPP response or event message.</p> |
| <p class="code"> |
| ipp_status_t ippGetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP response or event message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Status code in IPP message</p> |
| <h3 class="function"><a id="ippGetString">ippGetString</a></h3> |
| <p class="description"></p> |
| <p class="code"> |
| const char *ippGetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, const char **language);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>language</th> |
| <td class="description">Language code (<code>NULL</code> for don't care)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Get the string and optionally the language code for an attribute.</p> |
| <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to |
| <code>ippGetCount(attr)</code> - 1. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetValueTag">ippGetValueTag</a></h3> |
| <p class="description">Get the value tag for an attribute.</p> |
| <p class="code"> |
| ipp_tag_t ippGetValueTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetVersion">ippGetVersion</a></h3> |
| <p class="description">Get the major and minor version number from an IPP message.</p> |
| <p class="code"> |
| int ippGetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int *minor);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>minor</th> |
| <td class="description">Minor version number or <code>NULL</code> for don't care</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Major version number or 0 on error</p> |
| <h3 class="function"><a id="ippLength">ippLength</a></h3> |
| <p class="description">Compute the length of an IPP message.</p> |
| <p class="code"> |
| size_t ippLength(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Size of IPP message</p> |
| <h3 class="function"><a id="ippNew">ippNew</a></h3> |
| <p class="description">Allocate a new IPP message.</p> |
| <p class="code"> |
| <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/macOS 10.5 </span><a id="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(ipp_op_t op);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>op</th> |
| <td class="description">Operation code</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP request message</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The new request message is initialized with the "attributes-charset" and |
| "attributes-natural-language" attributes added. The |
| "attributes-natural-language" value is derived from the current locale. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippNewResponse">ippNewResponse</a></h3> |
| <p class="description">Allocate a new IPP response message.</p> |
| <p class="code"> |
| <a href="#ipp_t">ipp_t</a> *ippNewResponse(<a href="#ipp_t">ipp_t</a> *request);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>request</th> |
| <td class="description">IPP request message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">IPP response message</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The new response message is initialized with the same "version-number", |
| "request-id", "attributes-charset", and "attributes-natural-language" as the |
| provided request message. If the "attributes-charset" or |
| "attributes-natural-language" attributes are missing from the request, |
| 'utf-8' and a value derived from the current locale are substituted, |
| respectively. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippNextAttribute">ippNextAttribute</a></h3> |
| <p class="description">Return the next attribute in the message.</p> |
| <p class="code"> |
| <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Next attribute or <code>NULL</code> if none</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpString">ippOpString</a></h3> |
| <p class="description">Return a name for the given operation id.</p> |
| <p class="code"> |
| const char *ippOpString(ipp_op_t op);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>op</th> |
| <td class="description">Operation ID</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Name</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpValue">ippOpValue</a></h3> |
| <p class="description">Return an operation id for the given name.</p> |
| <p class="code"> |
| ipp_op_t ippOpValue(const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Textual name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Operation ID</p> |
| <h3 class="function"><a id="ippPort">ippPort</a></h3> |
| <p class="description">Return the default IPP port number.</p> |
| <p class="code"> |
| int ippPort(void);</p> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Port number</p> |
| <h3 class="function"><a id="ippRead">ippRead</a></h3> |
| <p class="description">Read data for an IPP message from a HTTP connection.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippRead(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippReadFile">ippReadFile</a></h3> |
| <p class="description">Read data for an IPP message from a file.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippReadFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>fd</th> |
| <td class="description">HTTP data</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippReadIO">ippReadIO</a></h3> |
| <p class="description">Read data for an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippReadIO(void *src, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>src</th> |
| <td class="description">Data source</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Read callback function</td></tr> |
| <tr><th>blocking</th> |
| <td class="description">Use blocking IO?</td></tr> |
| <tr><th>parent</th> |
| <td class="description">Parent request, if any</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetBoolean">ippSetBoolean</a></h3> |
| <p class="description">Set a boolean value in an attribute.</p> |
| <p class="code"> |
| int ippSetBoolean(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int boolvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>boolvalue</th> |
| <td class="description">Boolean value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetCollection">ippSetCollection</a></h3> |
| <p class="description">Set a collection value in an attribute.</p> |
| <p class="code"> |
| int ippSetCollection(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_t">ipp_t</a> *colvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>colvalue</th> |
| <td class="description">Collection value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetDate">ippSetDate</a></h3> |
| <p class="description">Set a dateTime value in an attribute.</p> |
| <p class="code"> |
| int ippSetDate(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *datevalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>datevalue</th> |
| <td class="description">dateTime value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetGroupTag">ippSetGroupTag</a></h3> |
| <p class="description">Set the group tag of an attribute.</p> |
| <p class="code"> |
| int ippSetGroupTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t group_tag);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| <tr><th>group_tag</th> |
| <td class="description">Group tag</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>group</code> parameter specifies the IPP attribute group tag: none |
| (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetInteger">ippSetInteger</a></h3> |
| <p class="description">Set an integer or enum value in an attribute.</p> |
| <p class="code"> |
| int ippSetInteger(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int intvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>intvalue</th> |
| <td class="description">Integer/enum value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetName">ippSetName</a></h3> |
| <p class="description">Set the name of an attribute.</p> |
| <p class="code"> |
| int ippSetName(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>name</th> |
| <td class="description">Attribute name</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetOctetString">ippSetOctetString</a></h3> |
| <p class="description">Set an octetString value in an IPP attribute.</p> |
| <p class="code"> |
| int ippSetOctetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const void *data, int datalen);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>data</th> |
| <td class="description">Pointer to octetString data</td></tr> |
| <tr><th>datalen</th> |
| <td class="description">Length of octetString data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetOperation">ippSetOperation</a></h3> |
| <p class="description">Set the operation ID in an IPP request message.</p> |
| <p class="code"> |
| int ippSetOperation(<a href="#ipp_t">ipp_t</a> *ipp, ipp_op_t op);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP request message</td></tr> |
| <tr><th>op</th> |
| <td class="description">Operation ID</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. |
| |
| </p> |
| <h3 class="function"><a id="ippSetPort">ippSetPort</a></h3> |
| <p class="description">Set the default port number.</p> |
| <p class="code"> |
| void ippSetPort(int p);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>p</th> |
| <td class="description">Port number to use</td></tr> |
| </tbody></table> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRange">ippSetRange</a></h3> |
| <p class="description">Set a rangeOfInteger value in an attribute.</p> |
| <p class="code"> |
| int ippSetRange(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int lowervalue, int uppervalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>lowervalue</th> |
| <td class="description">Lower bound for range</td></tr> |
| <tr><th>uppervalue</th> |
| <td class="description">Upper bound for range</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRequestId">ippSetRequestId</a></h3> |
| <p class="description">Set the request ID in an IPP message.</p> |
| <p class="code"> |
| int ippSetRequestId(<a href="#ipp_t">ipp_t</a> *ipp, int request_id);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>request_id</th> |
| <td class="description">Request ID</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>request_id</code> parameter must be greater than 0. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetResolution">ippSetResolution</a></h3> |
| <p class="description">Set a resolution value in an attribute.</p> |
| <p class="code"> |
| int ippSetResolution(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_res_t">ipp_res_t</a> unitsvalue, int xresvalue, int yresvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>unitsvalue</th> |
| <td class="description">Resolution units</td></tr> |
| <tr><th>xresvalue</th> |
| <td class="description">Horizontal/cross feed resolution</td></tr> |
| <tr><th>yresvalue</th> |
| <td class="description">Vertical/feed resolution</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetState">ippSetState</a></h3> |
| <p class="description">Set the current state of the IPP message.</p> |
| <p class="code"> |
| int ippSetState(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_state_t">ipp_state_t</a> state);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>state</th> |
| <td class="description">IPP state value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetStatusCode">ippSetStatusCode</a></h3> |
| <p class="description">Set the status code in an IPP response or event message.</p> |
| <p class="code"> |
| int ippSetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp, ipp_status_t status);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP response or event message</td></tr> |
| <tr><th>status</th> |
| <td class="description">Status code</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetString">ippSetString</a></h3> |
| <p class="description">Set a string value in an attribute.</p> |
| <p class="code"> |
| int ippSetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *strvalue);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>strvalue</th> |
| <td class="description">String value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringf">ippSetStringf</a></h3> |
| <p class="description">Set a formatted string value of an attribute.</p> |
| <p class="code"> |
| int ippSetStringf(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, ...);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>format</th> |
| <td class="description">Printf-style format string</td></tr> |
| <tr><th>...</th> |
| <td class="description">Additional arguments as needed</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>.<br> |
| <br> |
| The <code>format</code> parameter uses formatting characters compatible with the |
| printf family of standard functions. Additional arguments follow it as |
| needed. The formatted string is truncated as needed to the maximum length of |
| the corresponding value type. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringfv">ippSetStringfv</a></h3> |
| <p class="description">Set a formatted string value of an attribute.</p> |
| <p class="code"> |
| int ippSetStringfv(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, va_list ap);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>element</th> |
| <td class="description">Value number (0-based)</td></tr> |
| <tr><th>format</th> |
| <td class="description">Printf-style format string</td></tr> |
| <tr><th>ap</th> |
| <td class="description">Pointer to additional arguments</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| The <code>element</code> parameter specifies which value to set from 0 to |
| <code>ippGetCount(attr)</code>.<br> |
| <br> |
| The <code>format</code> parameter uses formatting characters compatible with the |
| printf family of standard functions. Additional arguments follow it as |
| needed. The formatted string is truncated as needed to the maximum length of |
| the corresponding value type. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetValueTag">ippSetValueTag</a></h3> |
| <p class="description">Set the value tag of an attribute.</p> |
| <p class="code"> |
| int ippSetValueTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t value_tag);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>attr</th> |
| <td class="description">IPP attribute</td></tr> |
| <tr><th>value_tag</th> |
| <td class="description">Value tag</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The <code>attr</code> parameter may be modified as a result of setting the value.<br> |
| <br> |
| Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger |
| (<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name |
| (<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text |
| (<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage |
| (<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various |
| out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other changes |
| will be rejected.<br> |
| <br> |
| Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language |
| code in the "attributes-natural-language" attribute or, if not present, the language |
| code for the current locale. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetVersion">ippSetVersion</a></h3> |
| <p class="description">Set the version number in an IPP message.</p> |
| <p class="code"> |
| int ippSetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int major, int minor);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| <tr><th>major</th> |
| <td class="description">Major version number (major.minor)</td></tr> |
| <tr><th>minor</th> |
| <td class="description">Minor version number (major.minor)</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 on success, 0 on failure</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using |
| the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> |
| <br> |
| The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="ippStateString">ippStateString</a></h3> |
| <p class="description">Return the name corresponding to a state value.</p> |
| <p class="code"> |
| const char *ippStateString(<a href="#ipp_state_t">ipp_state_t</a> state);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>state</th> |
| <td class="description">State value</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">State name</p> |
| <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagString">ippTagString</a></h3> |
| <p class="description">Return the tag name corresponding to a tag value.</p> |
| <p class="code"> |
| const char *ippTagString(ipp_tag_t tag);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>tag</th> |
| <td class="description">Tag value</td></tr> |
| </tbody></table> |
| <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 8011 and the IANA IPP Registry. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagValue">ippTagValue</a></h3> |
| <p class="description">Return the tag value corresponding to a tag name.</p> |
| <p class="code"> |
| ipp_tag_t ippTagValue(const char *name);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>name</th> |
| <td class="description">Tag name</td></tr> |
| </tbody></table> |
| <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 8011 and the IANA IPP Registry. |
| |
| </p> |
| <h3 class="function"><a id="ippTimeToDate">ippTimeToDate</a></h3> |
| <p class="description">Convert from time in seconds to RFC 2579 format.</p> |
| <p class="code"> |
| const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate(time_t t);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>t</th> |
| <td class="description">Time in seconds</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">RFC-2579 date/time data</p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttribute">ippValidateAttribute</a></h3> |
| <p class="description">Validate the contents of an attribute.</p> |
| <p class="code"> |
| int ippValidateAttribute(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>attr</th> |
| <td class="description">Attribute</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if valid, 0 otherwise</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function validates the contents of an attribute based on the name and |
| value tag. 1 is returned if the attribute is valid, 0 otherwise. On |
| failure, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is set to a human-readable message. |
| |
| </p> |
| <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttributes">ippValidateAttributes</a></h3> |
| <p class="description">Validate all attributes in an IPP message.</p> |
| <p class="code"> |
| int ippValidateAttributes(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>ipp</th> |
| <td class="description">IPP message</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">1 if valid, 0 otherwise</p> |
| <h4 class="discussion">Discussion</h4> |
| <p class="discussion">This function validates the contents of the IPP message, including each |
| attribute. Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is |
| set to a human-readable message on failure. |
| |
| </p> |
| <h3 class="function"><a id="ippWrite">ippWrite</a></h3> |
| <p class="description">Write data for an IPP message to a HTTP connection.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippWrite(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>http</th> |
| <td class="description">HTTP connection</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippWriteFile">ippWriteFile</a></h3> |
| <p class="description">Write data for an IPP message to a file.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippWriteFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>fd</th> |
| <td class="description">HTTP data</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippWriteIO">ippWriteIO</a></h3> |
| <p class="description">Write data for an IPP message.</p> |
| <p class="code"> |
| <a href="#ipp_state_t">ipp_state_t</a> ippWriteIO(void *dst, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| <h4 class="parameters">Parameters</h4> |
| <table class="list"><tbody> |
| <tr><th>dst</th> |
| <td class="description">Destination</td></tr> |
| <tr><th>cb</th> |
| <td class="description">Write callback function</td></tr> |
| <tr><th>blocking</th> |
| <td class="description">Use blocking IO?</td></tr> |
| <tr><th>parent</th> |
| <td class="description">Parent IPP message</td></tr> |
| <tr><th>ipp</th> |
| <td class="description">IPP data</td></tr> |
| </tbody></table> |
| <h4 class="returnvalue">Return Value</h4> |
| <p class="description">Current state</p> |
| <h2 class="title"><a id="TYPES">Data Types</a></h2> |
| <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_client_cert_cb_t</a></h3> |
| <p class="description">Client credentials callback |
| </p> |
| <p class="code"> |
| typedef int(*)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data)cups_client_cert_cb_t; |
| </p> |
| <h3 class="typedef"><a id="cups_dest_cb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dest_cb_t</a></h3> |
| <p class="description">Destination enumeration callback |
| </p> |
| <p class="code"> |
| typedef int(*)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest)cups_dest_cb_t; |
| </p> |
| <h3 class="typedef"><a id="cups_dest_t">cups_dest_t</a></h3> |
| <p class="description">Destination</p> |
| <p class="code"> |
| typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; |
| </p> |
| <h3 class="typedef"><a id="cups_dinfo_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dinfo_t</a></h3> |
| <p class="description">Destination capability and status |
| information </p> |
| <p class="code"> |
| typedef struct _cups_dinfo_s cups_dinfo_t; |
| </p> |
| <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3> |
| <p class="description">Job</p> |
| <p class="code"> |
| typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t; |
| </p> |
| <h3 class="typedef"><a id="cups_option_t">cups_option_t</a></h3> |
| <p class="description">Printer Options</p> |
| <p class="code"> |
| typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; |
| </p> |
| <h3 class="typedef"><a id="cups_password_cb2_t"><span class="info"> CUPS 1.4/macOS 10.6 </span>cups_password_cb2_t</a></h3> |
| <p class="description">New password callback |
| </p> |
| <p class="code"> |
| typedef const char *(*)(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource, void *user_data)cups_password_cb2_t; |
| </p> |
| <h3 class="typedef"><a id="cups_ptype_t">cups_ptype_t</a></h3> |
| <p class="description">Printer type/capability bits</p> |
| <p class="code"> |
| typedef unsigned cups_ptype_t; |
| </p> |
| <h3 class="typedef"><a id="cups_server_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_server_cert_cb_t</a></h3> |
| <p class="description">Server credentials callback |
| </p> |
| <p class="code"> |
| typedef int(*)(http_t *http, void *tls, cups_array_t *certs, void *user_data)cups_server_cert_cb_t; |
| </p> |
| <h3 class="typedef"><a id="cups_size_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_size_t</a></h3> |
| <p class="description">Media Size </p> |
| <p class="code"> |
| typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t; |
| </p> |
| <h3 class="typedef"><a id="http_addr_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>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"><a id="http_encoding_t">http_encoding_t</a></h3> |
| <p class="description">HTTP transfer encoding values</p> |
| <p class="code"> |
| typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t; |
| </p> |
| <h3 class="typedef"><a id="http_encryption_t">http_encryption_t</a></h3> |
| <p class="description">HTTP encryption values</p> |
| <p class="code"> |
| typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t; |
| </p> |
| <h3 class="typedef"><a id="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 id="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 id="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 id="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 id="http_timeout_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>http_timeout_cb_t</a></h3> |
| <p class="description">HTTP timeout callback </p> |
| <p class="code"> |
| typedef int(*)(http_t *http, void *user_data)http_timeout_cb_t; |
| </p> |
| <h3 class="typedef"><a id="http_trust_t"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_t</a></h3> |
| <p class="description">Level of trust for credentials </p> |
| <p class="code"> |
| typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t; |
| </p> |
| <h3 class="typedef"><a id="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"><a id="http_uri_status_t"><span class="info"> CUPS 1.2 </span>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 id="ipp_attribute_t">ipp_attribute_t</a></h3> |
| <p class="description">IPP attribute</p> |
| <p class="code"> |
| typedef struct _ipp_attribute_s ipp_attribute_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_copycb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>ipp_copycb_t</a></h3> |
| <p class="description">ippCopyAttributes callback function </p> |
| <p class="code"> |
| typedef int(*)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr)ipp_copycb_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_iocb_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ipp_iocb_t</a></h3> |
| <p class="description">ippReadIO/ippWriteIO callback function </p> |
| <p class="code"> |
| typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t; |
| </p> |
| <h3 class="typedef"><a id="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 id="ipp_pstate_t">ipp_pstate_t</a></h3> |
| <p class="description">Printer state values</p> |
| <p class="code"> |
| typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_quality_t">ipp_quality_t</a></h3> |
| <p class="description">Print quality values</p> |
| <p class="code"> |
| typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t; |
| </p> |
| <h3 class="typedef"><a id="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 id="ipp_rstate_t">ipp_rstate_t</a></h3> |
| <p class="description">resource-state values</p> |
| <p class="code"> |
| typedef enum <a href="#ipp_rstate_e">ipp_rstate_e</a> ipp_rstate_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_sstate_t">ipp_sstate_t</a></h3> |
| <p class="description">system-state values</p> |
| <p class="code"> |
| typedef enum <a href="#ipp_sstate_e">ipp_sstate_e</a> ipp_sstate_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_state_t">ipp_state_t</a></h3> |
| <p class="description">ipp_t state values</p> |
| <p class="code"> |
| typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t; |
| </p> |
| <h3 class="typedef"><a id="ipp_t">ipp_t</a></h3> |
| <p class="description">IPP request/response data</p> |
| <p class="code"> |
| typedef struct _ipp_s ipp_t; |
| </p> |
| <h2 class="title"><a id="STRUCTURES">Structures</a></h2> |
| <h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3> |
| <p class="description">Destination</p> |
| <p class="code">struct cups_dest_s {<br> |
|     char *name, *instance;<br> |
|     int is_default;<br> |
|     int num_options;<br> |
|     <a href="#cups_option_t">cups_option_t</a> *options;<br> |
| };</p> |
| <h4 class="members">Members</h4> |
| <table class="list"><tbody> |
| <tr><th>instance </th> |
| <td class="description">Local instance name or NULL</td></tr> |
| <tr><th>is_default </th> |
| <td class="description">Is this printer the default?</td></tr> |
| <tr><th>num_options </th> |
| <td class="description">Number of options</td></tr> |
| <tr><th>options </th> |
| <td class="description">Options</td></tr> |
| </tbody></table> |
| <h3 class="struct"><a id="cups_job_s">cups_job_s</a></h3> |
| <p class="description">Job</p> |
| <p class="code">struct cups_job_s {<br> |
|     time_t completed_time;<br> |
|     time_t creation_time;<br> |
|     char *dest;<br> |
|     char *format;<br> |
|     int id;<br> |
|     int priority;<br> |
|     time_t processing_time;<br> |
|     int size;<br> |
|     ipp_jstate_t state;<br> |
|     char *title;<br> |
|     char *user;<br> |
| };</p> |
| <h4 class="members">Members</h4> |
| <table class="list"><tbody> |
| <tr><th>completed_time </th> |
| <td class="description">Time the job was completed</td></tr> |
| <tr><th>creation_time </th> |
| <td class="description">Time the job was created</td></tr> |
| <tr><th>dest </th> |
| <td class="description">Printer or class name</td></tr> |
| <tr><th>format </th> |
| <td class="description">Document format</td></tr> |
| <tr><th>id </th> |
| <td class="description">The job ID</td></tr> |
| <tr><th>priority </th> |
| <td class="description">Priority (1-100)</td></tr> |
| <tr><th>processing_time </th> |
| <td class="description">Time the job was processed</td></tr> |
| <tr><th>size </th> |
| <td class="description">Size in kilobytes</td></tr> |
| <tr><th>state </th> |
| <td class="description">Job state</td></tr> |
| <tr><th>title </th> |
| <td class="description">Title/job name</td></tr> |
| <tr><th>user </th> |
| <td class="description">User that submitted the job</td></tr> |
| </tbody></table> |
| <h3 class="struct"><a id="cups_option_s">cups_option_s</a></h3> |
| <p class="description">Printer Options</p> |
| <p class="code">struct cups_option_s {<br> |
|     char *name;<br> |
|     char *value;<br> |
| };</p> |
| <h4 class="members">Members</h4> |
| <table class="list"><tbody> |
| <tr><th>name </th> |
| <td class="description">Name of option</td></tr> |
| <tr><th>value </th> |
| <td class="description">Value of option</td></tr> |
| </tbody></table> |
| <h3 class="struct"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cups_size_s">cups_size_s</a></h3> |
| <p class="description">Media Size </p> |
| <p class="code">struct cups_size_s {<br> |
|     char media[128];<br> |
|     int width, length, bottom, left, right, top;<br> |
| };</p> |
| <h4 class="members">Members</h4> |
| <table class="list"><tbody> |
| <tr><th>media[128] </th> |
| <td class="description">Media name to use</td></tr> |
| <tr><th>top </th> |
| <td class="description">Top margin in hundredths of |
| millimeters</td></tr> |
| </tbody></table> |
| <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> |
| <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> |
| <p class="description">Printer type/capability bit |
| constants</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>CUPS_PRINTER_AUTHENTICATED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer requires authentication |
| </td></tr> |
| <tr><th>CUPS_PRINTER_BIND </th> <td class="description">Can bind output</td></tr> |
| <tr><th>CUPS_PRINTER_BW </th> <td class="description">Can do B&W printing</td></tr> |
| <tr><th>CUPS_PRINTER_CLASS </th> <td class="description">Printer class</td></tr> |
| <tr><th>CUPS_PRINTER_COLLATE </th> <td class="description">Can quickly collate copies</td></tr> |
| <tr><th>CUPS_PRINTER_COLOR </th> <td class="description">Can do color printing</td></tr> |
| <tr><th>CUPS_PRINTER_COMMANDS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer supports maintenance commands |
| </td></tr> |
| <tr><th>CUPS_PRINTER_COPIES </th> <td class="description">Can do copies in hardware</td></tr> |
| <tr><th>CUPS_PRINTER_COVER </th> <td class="description">Can cover output</td></tr> |
| <tr><th>CUPS_PRINTER_DEFAULT </th> <td class="description">Default printer on network</td></tr> |
| <tr><th>CUPS_PRINTER_DISCOVERED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer was discovered </td></tr> |
| <tr><th>CUPS_PRINTER_DUPLEX </th> <td class="description">Can do two-sided printing</td></tr> |
| <tr><th>CUPS_PRINTER_FAX </th> <td class="description">Fax queue</td></tr> |
| <tr><th>CUPS_PRINTER_LARGE </th> <td class="description">Can print on D/E/A1/A0-size media</td></tr> |
| <tr><th>CUPS_PRINTER_LOCAL </th> <td class="description">Local printer or class</td></tr> |
| <tr><th>CUPS_PRINTER_MEDIUM </th> <td class="description">Can print on Tabloid/B/C/A3/A2-size media</td></tr> |
| <tr><th>CUPS_PRINTER_NOT_SHARED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer is not shared |
| </td></tr> |
| <tr><th>CUPS_PRINTER_PUNCH </th> <td class="description">Can punch output</td></tr> |
| <tr><th>CUPS_PRINTER_REJECTING </th> <td class="description">Printer is rejecting jobs</td></tr> |
| <tr><th>CUPS_PRINTER_REMOTE </th> <td class="description">Remote printer or class</td></tr> |
| <tr><th>CUPS_PRINTER_SMALL </th> <td class="description">Can print on Letter/Legal/A4-size media</td></tr> |
| <tr><th>CUPS_PRINTER_SORT </th> <td class="description">Can sort output</td></tr> |
| <tr><th>CUPS_PRINTER_STAPLE </th> <td class="description">Can staple output</td></tr> |
| <tr><th>CUPS_PRINTER_VARIABLE </th> <td class="description">Can print on rolls and custom-size media</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3> |
| <p class="description">HTTP transfer encoding values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_ENCODING_CHUNKED </th> <td class="description">Data is chunked</td></tr> |
| <tr><th>HTTP_ENCODING_FIELDS </th> <td class="description">Sending HTTP fields</td></tr> |
| <tr><th>HTTP_ENCODING_LENGTH </th> <td class="description">Data is sent with Content-Length</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_encryption_e">http_encryption_e</a></h3> |
| <p class="description">HTTP encryption values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_ENCRYPTION_ALWAYS </th> <td class="description">Always encrypt (SSL)</td></tr> |
| <tr><th>HTTP_ENCRYPTION_IF_REQUESTED </th> <td class="description">Encrypt if requested (TLS upgrade)</td></tr> |
| <tr><th>HTTP_ENCRYPTION_NEVER </th> <td class="description">Never encrypt</td></tr> |
| <tr><th>HTTP_ENCRYPTION_REQUIRED </th> <td class="description">Encryption is required (TLS upgrade)</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_field_e">http_field_e</a></h3> |
| <p class="description">HTTP field names</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_FIELD_ACCEPT_ENCODING <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Accepting-Encoding field </td></tr> |
| <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th> <td class="description">Accept-Language field</td></tr> |
| <tr><th>HTTP_FIELD_ACCEPT_RANGES </th> <td class="description">Accept-Ranges field</td></tr> |
| <tr><th>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Allow field </td></tr> |
| <tr><th>HTTP_FIELD_AUTHENTICATION_INFO <span class="info"> CUPS 2.2.9) </span></th> <td class="description">Authentication-Info field (</td></tr> |
| <tr><th>HTTP_FIELD_AUTHORIZATION </th> <td class="description">Authorization field</td></tr> |
| <tr><th>HTTP_FIELD_CONNECTION </th> <td class="description">Connection field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_ENCODING </th> <td class="description">Content-Encoding field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_LANGUAGE </th> <td class="description">Content-Language field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_LENGTH </th> <td class="description">Content-Length field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_LOCATION </th> <td class="description">Content-Location field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_MD5 </th> <td class="description">Content-MD5 field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_RANGE </th> <td class="description">Content-Range field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_TYPE </th> <td class="description">Content-Type field</td></tr> |
| <tr><th>HTTP_FIELD_CONTENT_VERSION </th> <td class="description">Content-Version field</td></tr> |
| <tr><th>HTTP_FIELD_DATE </th> <td class="description">Date field</td></tr> |
| <tr><th>HTTP_FIELD_HOST </th> <td class="description">Host field</td></tr> |
| <tr><th>HTTP_FIELD_IF_MODIFIED_SINCE </th> <td class="description">If-Modified-Since field</td></tr> |
| <tr><th>HTTP_FIELD_IF_UNMODIFIED_SINCE </th> <td class="description">If-Unmodified-Since field</td></tr> |
| <tr><th>HTTP_FIELD_KEEP_ALIVE </th> <td class="description">Keep-Alive field</td></tr> |
| <tr><th>HTTP_FIELD_LAST_MODIFIED </th> <td class="description">Last-Modified field</td></tr> |
| <tr><th>HTTP_FIELD_LINK </th> <td class="description">Link field</td></tr> |
| <tr><th>HTTP_FIELD_LOCATION </th> <td class="description">Location field</td></tr> |
| <tr><th>HTTP_FIELD_MAX </th> <td class="description">Maximum field index</td></tr> |
| <tr><th>HTTP_FIELD_RANGE </th> <td class="description">Range field</td></tr> |
| <tr><th>HTTP_FIELD_REFERER </th> <td class="description">Referer field</td></tr> |
| <tr><th>HTTP_FIELD_RETRY_AFTER </th> <td class="description">Retry-After field</td></tr> |
| <tr><th>HTTP_FIELD_SERVER <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Server field </td></tr> |
| <tr><th>HTTP_FIELD_TRANSFER_ENCODING </th> <td class="description">Transfer-Encoding field</td></tr> |
| <tr><th>HTTP_FIELD_UNKNOWN </th> <td class="description">Unknown field</td></tr> |
| <tr><th>HTTP_FIELD_UPGRADE </th> <td class="description">Upgrade field</td></tr> |
| <tr><th>HTTP_FIELD_USER_AGENT </th> <td class="description">User-Agent field</td></tr> |
| <tr><th>HTTP_FIELD_WWW_AUTHENTICATE </th> <td class="description">WWW-Authenticate field</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_keepalive_e">http_keepalive_e</a></h3> |
| <p class="description">HTTP keep-alive values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_KEEPALIVE_OFF </th> <td class="description">No keep alive support</td></tr> |
| <tr><th>HTTP_KEEPALIVE_ON </th> <td class="description">Use keep alive</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_state_e">http_state_e</a></h3> |
| <p class="description">HTTP state values; states |
| are server-oriented...</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_STATE_CONNECT </th> <td class="description">CONNECT command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_DELETE </th> <td class="description">DELETE command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_ERROR </th> <td class="description">Error on socket</td></tr> |
| <tr><th>HTTP_STATE_GET </th> <td class="description">GET command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_GET_SEND </th> <td class="description">GET command, sending data</td></tr> |
| <tr><th>HTTP_STATE_HEAD </th> <td class="description">HEAD command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_OPTIONS </th> <td class="description">OPTIONS command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_POST </th> <td class="description">POST command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_POST_RECV </th> <td class="description">POST command, receiving data</td></tr> |
| <tr><th>HTTP_STATE_POST_SEND </th> <td class="description">POST command, sending data</td></tr> |
| <tr><th>HTTP_STATE_PUT </th> <td class="description">PUT command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_PUT_RECV </th> <td class="description">PUT command, receiving data</td></tr> |
| <tr><th>HTTP_STATE_STATUS </th> <td class="description">Command complete, sending status</td></tr> |
| <tr><th>HTTP_STATE_TRACE </th> <td class="description">TRACE command, waiting for blank line</td></tr> |
| <tr><th>HTTP_STATE_UNKNOWN_METHOD <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> |
| <tr><th>HTTP_STATE_UNKNOWN_VERSION <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> |
| <tr><th>HTTP_STATE_WAITING </th> <td class="description">Waiting for command</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_status_e">http_status_e</a></h3> |
| <p class="description">HTTP status codes</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_STATUS_ACCEPTED </th> <td class="description">DELETE command was successful</td></tr> |
| <tr><th>HTTP_STATUS_BAD_GATEWAY </th> <td class="description">Bad gateway</td></tr> |
| <tr><th>HTTP_STATUS_BAD_REQUEST </th> <td class="description">Bad request</td></tr> |
| <tr><th>HTTP_STATUS_CONFLICT </th> <td class="description">Request is self-conflicting</td></tr> |
| <tr><th>HTTP_STATUS_CONTINUE </th> <td class="description">Everything OK, keep going...</td></tr> |
| <tr><th>HTTP_STATUS_CREATED </th> <td class="description">PUT command was successful</td></tr> |
| <tr><th>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></th> <td class="description">User canceled authorization </td></tr> |
| <tr><th>HTTP_STATUS_CUPS_PKI_ERROR <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">Error negotiating a secure connection </td></tr> |
| <tr><th>HTTP_STATUS_ERROR </th> <td class="description">An error response from httpXxxx()</td></tr> |
| <tr><th>HTTP_STATUS_EXPECTATION_FAILED </th> <td class="description">The expectation given in an Expect header field was not met</td></tr> |
| <tr><th>HTTP_STATUS_FORBIDDEN </th> <td class="description">Forbidden to access this URI</td></tr> |
| <tr><th>HTTP_STATUS_FOUND </th> <td class="description">Document was found at a different URI</td></tr> |
| <tr><th>HTTP_STATUS_GATEWAY_TIMEOUT </th> <td class="description">Gateway connection timed out</td></tr> |
| <tr><th>HTTP_STATUS_GONE </th> <td class="description">Server has gone away</td></tr> |
| <tr><th>HTTP_STATUS_LENGTH_REQUIRED </th> <td class="description">A content length or encoding is required</td></tr> |
| <tr><th>HTTP_STATUS_METHOD_NOT_ALLOWED </th> <td class="description">Method is not allowed</td></tr> |
| <tr><th>HTTP_STATUS_MOVED_PERMANENTLY </th> <td class="description">Document has moved permanently</td></tr> |
| <tr><th>HTTP_STATUS_MULTIPLE_CHOICES </th> <td class="description">Multiple files match request</td></tr> |
| <tr><th>HTTP_STATUS_NONE <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">No Expect value </td></tr> |
| <tr><th>HTTP_STATUS_NOT_ACCEPTABLE </th> <td class="description">Not Acceptable</td></tr> |
| <tr><th>HTTP_STATUS_NOT_AUTHORITATIVE </th> <td class="description">Information isn't authoritative</td></tr> |
| <tr><th>HTTP_STATUS_NOT_FOUND </th> <td class="description">URI was not found</td></tr> |
| <tr><th>HTTP_STATUS_NOT_IMPLEMENTED </th> <td class="description">Feature not implemented</td></tr> |
| <tr><th>HTTP_STATUS_NOT_MODIFIED </th> <td class="description">File not modified</td></tr> |
| <tr><th>HTTP_STATUS_NOT_SUPPORTED </th> <td class="description">HTTP version not supported</td></tr> |
| <tr><th>HTTP_STATUS_NO_CONTENT </th> <td class="description">Successful command, no new data</td></tr> |
| <tr><th>HTTP_STATUS_OK </th> <td class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</td></tr> |
| <tr><th>HTTP_STATUS_PARTIAL_CONTENT </th> <td class="description">Only a partial file was received/sent</td></tr> |
| <tr><th>HTTP_STATUS_PAYMENT_REQUIRED </th> <td class="description">Payment required</td></tr> |
| <tr><th>HTTP_STATUS_PRECONDITION </th> <td class="description">Precondition failed</td></tr> |
| <tr><th>HTTP_STATUS_PROXY_AUTHENTICATION </th> <td class="description">Proxy Authentication is Required</td></tr> |
| <tr><th>HTTP_STATUS_REQUESTED_RANGE </th> <td class="description">The requested range is not satisfiable</td></tr> |
| <tr><th>HTTP_STATUS_REQUEST_TIMEOUT </th> <td class="description">Request timed out</td></tr> |
| <tr><th>HTTP_STATUS_REQUEST_TOO_LARGE </th> <td class="description">Request entity too large</td></tr> |
| <tr><th>HTTP_STATUS_RESET_CONTENT </th> <td class="description">Content was reset/recreated</td></tr> |
| <tr><th>HTTP_STATUS_SEE_OTHER </th> <td class="description">See this other link</td></tr> |
| <tr><th>HTTP_STATUS_SERVER_ERROR </th> <td class="description">Internal server error</td></tr> |
| <tr><th>HTTP_STATUS_SERVICE_UNAVAILABLE </th> <td class="description">Service is unavailable</td></tr> |
| <tr><th>HTTP_STATUS_SWITCHING_PROTOCOLS </th> <td class="description">HTTP upgrade to TLS/SSL</td></tr> |
| <tr><th>HTTP_STATUS_TEMPORARY_REDIRECT </th> <td class="description">Temporary redirection</td></tr> |
| <tr><th>HTTP_STATUS_UNAUTHORIZED </th> <td class="description">Unauthorized to access host</td></tr> |
| <tr><th>HTTP_STATUS_UNSUPPORTED_MEDIATYPE </th> <td class="description">The requested media type is unsupported</td></tr> |
| <tr><th>HTTP_STATUS_UPGRADE_REQUIRED </th> <td class="description">Upgrade to SSL/TLS required</td></tr> |
| <tr><th>HTTP_STATUS_URI_TOO_LONG </th> <td class="description">URI too long</td></tr> |
| <tr><th>HTTP_STATUS_USE_PROXY </th> <td class="description">Must use a proxy to access this URI</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_trust_e"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_e</a></h3> |
| <p class="description">Level of trust for credentials </p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_TRUST_CHANGED </th> <td class="description">Credentials have changed</td></tr> |
| <tr><th>HTTP_TRUST_EXPIRED </th> <td class="description">Credentials are expired</td></tr> |
| <tr><th>HTTP_TRUST_INVALID </th> <td class="description">Credentials are invalid</td></tr> |
| <tr><th>HTTP_TRUST_OK </th> <td class="description">Credentials are OK/trusted</td></tr> |
| <tr><th>HTTP_TRUST_RENEWED </th> <td class="description">Credentials have been renewed</td></tr> |
| <tr><th>HTTP_TRUST_UNKNOWN </th> <td class="description">Credentials are unknown/new</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_uri_coding_e">http_uri_coding_e</a></h3> |
| <p class="description">URI en/decode flags</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_URI_CODING_ALL </th> <td class="description">En/decode everything</td></tr> |
| <tr><th>HTTP_URI_CODING_HOSTNAME </th> <td class="description">En/decode the hostname portion</td></tr> |
| <tr><th>HTTP_URI_CODING_MOST </th> <td class="description">En/decode all but the query</td></tr> |
| <tr><th>HTTP_URI_CODING_NONE </th> <td class="description">Don't en/decode anything</td></tr> |
| <tr><th>HTTP_URI_CODING_QUERY </th> <td class="description">En/decode the query portion</td></tr> |
| <tr><th>HTTP_URI_CODING_RESOURCE </th> <td class="description">En/decode the resource portion</td></tr> |
| <tr><th>HTTP_URI_CODING_RFC6874 </th> <td class="description">Use RFC 6874 address format</td></tr> |
| <tr><th>HTTP_URI_CODING_USERNAME </th> <td class="description">En/decode the username portion</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="http_uri_status_e"><span class="info"> CUPS 1.2 </span>http_uri_status_e</a></h3> |
| <p class="description">URI separation status </p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>HTTP_URI_STATUS_BAD_ARGUMENTS </th> <td class="description">Bad arguments to function (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_HOSTNAME </th> <td class="description">Bad hostname in URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_PORT </th> <td class="description">Bad port number in URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_RESOURCE </th> <td class="description">Bad resource in URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_SCHEME </th> <td class="description">Bad scheme in URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_URI </th> <td class="description">Bad/empty URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_BAD_USERNAME </th> <td class="description">Bad username in URI (error)</td></tr> |
| <tr><th>HTTP_URI_STATUS_MISSING_RESOURCE </th> <td class="description">Missing resource in URI (warning)</td></tr> |
| <tr><th>HTTP_URI_STATUS_MISSING_SCHEME </th> <td class="description">Missing scheme in URI (warning)</td></tr> |
| <tr><th>HTTP_URI_STATUS_OK </th> <td class="description">URI decoded OK</td></tr> |
| <tr><th>HTTP_URI_STATUS_OVERFLOW </th> <td class="description">URI buffer for httpAssembleURI is too small</td></tr> |
| <tr><th>HTTP_URI_STATUS_UNKNOWN_SCHEME </th> <td class="description">Unknown scheme in URI (warning)</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3> |
| <p class="description">Finishings values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_FINISHINGS_BALE </th> <td class="description">Bale (any type)</td></tr> |
| <tr><th>IPP_FINISHINGS_BIND </th> <td class="description">Bind</td></tr> |
| <tr><th>IPP_FINISHINGS_BIND_BOTTOM </th> <td class="description">Bind on bottom</td></tr> |
| <tr><th>IPP_FINISHINGS_BIND_LEFT </th> <td class="description">Bind on left</td></tr> |
| <tr><th>IPP_FINISHINGS_BIND_RIGHT </th> <td class="description">Bind on right</td></tr> |
| <tr><th>IPP_FINISHINGS_BIND_TOP </th> <td class="description">Bind on top</td></tr> |
| <tr><th>IPP_FINISHINGS_BOOKLET_MAKER </th> <td class="description">Fold to make booklet</td></tr> |
| <tr><th>IPP_FINISHINGS_COAT </th> <td class="description">Apply protective liquid or powder coating</td></tr> |
| <tr><th>IPP_FINISHINGS_COVER </th> <td class="description">Add cover</td></tr> |
| <tr><th>IPP_FINISHINGS_EDGE_STITCH </th> <td class="description">Stitch along any side</td></tr> |
| <tr><th>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </th> <td class="description">Stitch along bottom edge</td></tr> |
| <tr><th>IPP_FINISHINGS_EDGE_STITCH_LEFT </th> <td class="description">Stitch along left side</td></tr> |
| <tr><th>IPP_FINISHINGS_EDGE_STITCH_RIGHT </th> <td class="description">Stitch along right side</td></tr> |
| <tr><th>IPP_FINISHINGS_EDGE_STITCH_TOP </th> <td class="description">Stitch along top edge</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD </th> <td class="description">Fold (any type)</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_ACCORDION </th> <td class="description">Accordion-fold the paper vertically into four sections</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_DOUBLE_GATE </th> <td class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_ENGINEERING_Z </th> <td class="description">Fold the paper vertically into two small sections and one larger, forming an elongated Z</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_GATE </th> <td class="description">Fold the top and bottom quarters of the paper towards the midline</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_HALF </th> <td class="description">Fold the paper in half vertically</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_HALF_Z </th> <td class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_LEFT_GATE </th> <td class="description">Fold the top quarter of the paper towards the midline</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_LETTER </th> <td class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_PARALLEL </th> <td class="description">Fold the paper in half vertically two times, yielding four sections</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_POSTER </th> <td class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_RIGHT_GATE </th> <td class="description">Fold the bottom quarter of the paper towards the midline</td></tr> |
| <tr><th>IPP_FINISHINGS_FOLD_Z </th> <td class="description">Fold the paper vertically into three sections, forming a Z</td></tr> |
| <tr><th>IPP_FINISHINGS_JOG_OFFSET </th> <td class="description">Offset for binding (any type)</td></tr> |
| <tr><th>IPP_FINISHINGS_LAMINATE </th> <td class="description">Apply protective (solid) material</td></tr> |
| <tr><th>IPP_FINISHINGS_NONE </th> <td class="description">No finishing</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH </th> <td class="description">Punch (any location/count)</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </th> <td class="description">Punch 1 hole bottom left</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </th> <td class="description">Punch 1 hole bottom right</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </th> <td class="description">Punch 2 holes bottom edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_DUAL_LEFT </th> <td class="description">Punch 2 holes left side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </th> <td class="description">Punch 2 holes right side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_DUAL_TOP </th> <td class="description">Punch 2 holes top edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </th> <td class="description">Punch multiple holes bottom edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </th> <td class="description">Punch multiple holes left side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </th> <td class="description">Punch multiple holes right side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </th> <td class="description">Punch multiple holes top edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </th> <td class="description">Punch 4 holes bottom edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_QUAD_LEFT </th> <td class="description">Punch 4 holes left side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </th> <td class="description">Punch 4 holes right side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_QUAD_TOP </th> <td class="description">Punch 4 holes top edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TOP_LEFT </th> <td class="description">Punch 1 hole top left</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TOP_RIGHT </th> <td class="description">Punch 1 hole top right</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </th> <td class="description">Punch 3 holes bottom edge</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </th> <td class="description">Punch 3 holes left side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </th> <td class="description">Punch 3 holes right side</td></tr> |
| <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </th> <td class="description">Punch 3 holes top edge</td></tr> |
| <tr><th>IPP_FINISHINGS_SADDLE_STITCH </th> <td class="description">Staple interior</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE </th> <td class="description">Staple (any location/method)</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </th> <td class="description">Staple bottom left corner</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </th> <td class="description">Staple bottom right corner</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </th> <td class="description">Two staples on bottom</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_DUAL_LEFT </th> <td class="description">Two staples on left</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </th> <td class="description">Two staples on right</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_DUAL_TOP </th> <td class="description">Two staples on top</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TOP_LEFT </th> <td class="description">Staple top left corner</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TOP_RIGHT </th> <td class="description">Staple top right corner</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </th> <td class="description">Three staples on bottom</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </th> <td class="description">Three staples on left</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </th> <td class="description">Three staples on right</td></tr> |
| <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </th> <td class="description">Three staples on top</td></tr> |
| <tr><th>IPP_FINISHINGS_TRIM </th> <td class="description">Trim (any type)</td></tr> |
| <tr><th>IPP_FINISHINGS_TRIM_AFTER_COPIES </th> <td class="description">Trim output after each copy</td></tr> |
| <tr><th>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </th> <td class="description">Trim output after each document</td></tr> |
| <tr><th>IPP_FINISHINGS_TRIM_AFTER_JOB </th> <td class="description">Trim output after job</td></tr> |
| <tr><th>IPP_FINISHINGS_TRIM_AFTER_PAGES </th> <td class="description">Trim output after each page</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3> |
| <p class="description">Job states</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_JSTATE_ABORTED </th> <td class="description">Job has aborted due to error</td></tr> |
| <tr><th>IPP_JSTATE_CANCELED </th> <td class="description">Job has been canceled</td></tr> |
| <tr><th>IPP_JSTATE_COMPLETED </th> <td class="description">Job has completed successfully</td></tr> |
| <tr><th>IPP_JSTATE_HELD </th> <td class="description">Job is held for printing</td></tr> |
| <tr><th>IPP_JSTATE_PENDING </th> <td class="description">Job is waiting to be printed</td></tr> |
| <tr><th>IPP_JSTATE_PROCESSING </th> <td class="description">Job is currently printing</td></tr> |
| <tr><th>IPP_JSTATE_STOPPED </th> <td class="description">Job has been stopped</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_op_e">ipp_op_e</a></h3> |
| <p class="description">IPP operations</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_OP_ALLOCATE_PRINTER_RESOURCES </th> <td class="description">Allocate-Printer-Resources: Use resources for a printer.</td></tr> |
| <tr><th>IPP_OP_CANCEL_CURRENT_JOB </th> <td class="description">Cancel-Current-Job: Cancel the current job</td></tr> |
| <tr><th>IPP_OP_CANCEL_JOB </th> <td class="description">Cancel-Job: Cancel a job</td></tr> |
| <tr><th>IPP_OP_CANCEL_JOBS </th> <td class="description">Cancel-Jobs: Cancel all jobs (administrative)</td></tr> |
| <tr><th>IPP_OP_CANCEL_MY_JOBS </th> <td class="description">Cancel-My-Jobs: Cancel a user's jobs</td></tr> |
| <tr><th>IPP_OP_CANCEL_RESOURCE </th> <td class="description">Cancel-Resource: Uninstall a resource.</td></tr> |
| <tr><th>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Cancel-Subscription: Cancel a subscription </td></tr> |
| <tr><th>IPP_OP_CLOSE_JOB </th> <td class="description">Close-Job: Close a job and start printing</td></tr> |
| <tr><th>IPP_OP_CREATE_JOB </th> <td class="description">Create-Job: Create an empty print job</td></tr> |
| <tr><th>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Job-Subscriptions: Create one of more job subscriptions </td></tr> |
| <tr><th>IPP_OP_CREATE_PRINTER </th> <td class="description">Create-Printer: Create a new service.</td></tr> |
| <tr><th>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </td></tr> |
| <tr><th>IPP_OP_CREATE_RESOURCE </th> <td class="description">Create-Resource: Create a new (empty) resource.</td></tr> |
| <tr><th>IPP_OP_CREATE_RESOURCE_SUBSCRIPTIONS </th> <td class="description">Create-Resource-Subscriptions: Create event subscriptions for a resource.</td></tr> |
| <tr><th>IPP_OP_CREATE_SYSTEM_SUBSCRIPTIONS </th> <td class="description">Create-System-Subscriptions: Create event subscriptions for a system.</td></tr> |
| <tr><th>IPP_OP_CUPS_ADD_MODIFY_CLASS </th> <td class="description">CUPS-Add-Modify-Class: Add or modify a class</td></tr> |
| <tr><th>IPP_OP_CUPS_ADD_MODIFY_PRINTER </th> <td class="description">CUPS-Add-Modify-Printer: Add or modify a printer</td></tr> |
| <tr><th>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">CUPS-Authenticate-Job: Authenticate a job </td></tr> |
| <tr><th>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info"> CUPS 2.2 </span></th> <td class="description">CUPS-Create-Local-Printer: Create a local (temporary) printer </td></tr> |
| <tr><th>IPP_OP_CUPS_DELETE_CLASS </th> <td class="description">CUPS-Delete-Class: Delete a class</td></tr> |
| <tr><th>IPP_OP_CUPS_DELETE_PRINTER </th> <td class="description">CUPS-Delete-Printer: Delete a printer</td></tr> |
| <tr><th>IPP_OP_CUPS_GET_DEFAULT </th> <td class="description">CUPS-Get-Default: Get the default printer</td></tr> |
| <tr><th>IPP_OP_CUPS_GET_DEVICES <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-Devices: Get a list of supported devices </td></tr> |
| <tr><th>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/macOS 10.6 </span></th> <td class="description">CUPS-Get-Document: Get a document file </td></tr> |
| <tr><th>IPP_OP_CUPS_GET_PPD <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-PPD: Get a PPD file </td></tr> |
| <tr><th>IPP_OP_CUPS_GET_PPDS <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-PPDs: Get a list of supported drivers </td></tr> |
| <tr><th>IPP_OP_CUPS_GET_PRINTERS </th> <td class="description">CUPS-Get-Printers: Get a list of printers and/or classes</td></tr> |
| <tr><th>IPP_OP_CUPS_INVALID </th> <td class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></td></tr> |
| <tr><th>IPP_OP_CUPS_MOVE_JOB </th> <td class="description">CUPS-Move-Job: Move a job to a different printer</td></tr> |
| <tr><th>IPP_OP_CUPS_SET_DEFAULT </th> <td class="description">CUPS-Set-Default: Set the default printer</td></tr> |
| <tr><th>IPP_OP_DEALLOCATE_PRINTER_RESOURCES </th> <td class="description">Deallocate-Printer-Resources: Stop using resources for a printer.</td></tr> |
| <tr><th>IPP_OP_DELETE_PRINTER </th> <td class="description">Delete-Printer: Delete an existing service.</td></tr> |
| <tr><th>IPP_OP_DISABLE_ALL_PRINTERS </th> <td class="description">Disable-All-Printers: Stop accepting new jobs on all services.</td></tr> |
| <tr><th>IPP_OP_DISABLE_PRINTER </th> <td class="description">Disable-Printer: Reject new jobs for a printer</td></tr> |
| <tr><th>IPP_OP_ENABLE_ALL_PRINTERS </th> <td class="description">Enable-All-Printers: Start accepting new jobs on all services.</td></tr> |
| <tr><th>IPP_OP_ENABLE_PRINTER </th> <td class="description">Enable-Printer: Accept new jobs for a printer</td></tr> |
| <tr><th>IPP_OP_GET_JOBS </th> <td class="description">Get-Jobs: Get a list of jobs</td></tr> |
| <tr><th>IPP_OP_GET_JOB_ATTRIBUTES </th> <td class="description">Get-Job-Attribute: Get information about a job</td></tr> |
| <tr><th>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Notifications: Get notification events </td></tr> |
| <tr><th>IPP_OP_GET_PRINTERS </th> <td class="description">Get-Printers: Get a list of services.</td></tr> |
| <tr><th>IPP_OP_GET_PRINTER_ATTRIBUTES </th> <td class="description">Get-Printer-Attributes: Get information about a printer</td></tr> |
| <tr><th>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </th> <td class="description">Get-Printer-Supported-Values: Get supported values</td></tr> |
| <tr><th>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscriptions: Get list of subscriptions </td></tr> |
| <tr><th>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscription-Attributes: Get subscription information </td></tr> |
| <tr><th>IPP_OP_GET_SYSTEM_ATTRIBUTES </th> <td class="description">Get-System-Attributes: Get system object attributes.</td></tr> |
| <tr><th>IPP_OP_GET_SYSTEM_SUPPORTED_VALUES </th> <td class="description">Get-System-Supported-Values: Get supported values for system object attributes.</td></tr> |
| <tr><th>IPP_OP_HOLD_JOB </th> <td class="description">Hold-Job: Hold a job for printing</td></tr> |
| <tr><th>IPP_OP_HOLD_NEW_JOBS </th> <td class="description">Hold-New-Jobs: Hold new jobs</td></tr> |
| <tr><th>IPP_OP_IDENTIFY_PRINTER </th> <td class="description">Identify-Printer: Make the printer beep, flash, or display a message for identification</td></tr> |
| <tr><th>IPP_OP_INSTALL_RESOURCE </th> <td class="description">Install-Resource: Install a resource.</td></tr> |
| <tr><th>IPP_OP_PAUSE_ALL_PRINTERS </th> <td class="description">Pause-All-Printers: Stop all services immediately.</td></tr> |
| <tr><th>IPP_OP_PAUSE_ALL_PRINTERS_AFTER_CURRENT_JOB </th> <td class="description">Pause-All-Printers-After-Current-Job: Stop all services after processing the current jobs.</td></tr> |
| <tr><th>IPP_OP_PAUSE_PRINTER </th> <td class="description">Pause-Printer: Stop a printer</td></tr> |
| <tr><th>IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB </th> <td class="description">Pause-Printer-After-Current-Job: Stop printer after the current job</td></tr> |
| <tr><th>IPP_OP_PRINT_JOB </th> <td class="description">Print-Job: Print a single file</td></tr> |
| <tr><th>IPP_OP_PROMOTE_JOB </th> <td class="description">Promote-Job: Promote a job to print sooner</td></tr> |
| <tr><th>IPP_OP_REGISTER_OUTPUT_DEVICE </th> <td class="description">Register-Output-Device: Register a remote service.</td></tr> |
| <tr><th>IPP_OP_RELEASE_HELD_NEW_JOBS </th> <td class="description">Release-Held-New-Jobs: Release new jobs that were previously held</td></tr> |
| <tr><th>IPP_OP_RELEASE_JOB </th> <td class="description">Release-Job: Release a job for printing</td></tr> |
| <tr><th>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Renew-Subscription: Renew a printer subscription </td></tr> |
| <tr><th>IPP_OP_RESTART_JOB <span class="info"> DEPRECATED </span></th> <td class="description">Restart-Job: Reprint a job </td></tr> |
| <tr><th>IPP_OP_RESTART_SYSTEM </th> <td class="description">Restart-System: Restart all services.</td></tr> |
| <tr><th>IPP_OP_RESUME_ALL_PRINTERS </th> <td class="description">Resume-All-Printers: Start job processing on all services.</td></tr> |
| <tr><th>IPP_OP_RESUME_JOB </th> <td class="description">Resume-Job: Resume the current job</td></tr> |
| <tr><th>IPP_OP_RESUME_PRINTER </th> <td class="description">Resume-Printer: Start a printer</td></tr> |
| <tr><th>IPP_OP_SCHEDULE_JOB_AFTER </th> <td class="description">Schedule-Job-After: Schedule a job to print after another</td></tr> |
| <tr><th>IPP_OP_SEND_DOCUMENT </th> <td class="description">Send-Document: Add a file to a job</td></tr> |
| <tr><th>IPP_OP_SEND_RESOURCE_DATA </th> <td class="description">Send-Resource-Data: Upload the data for a resource.</td></tr> |
| <tr><th>IPP_OP_SET_JOB_ATTRIBUTES </th> <td class="description">Set-Job-Attributes: Set job values</td></tr> |
| <tr><th>IPP_OP_SET_PRINTER_ATTRIBUTES </th> <td class="description">Set-Printer-Attributes: Set printer values</td></tr> |
| <tr><th>IPP_OP_SET_RESOURCE_ATTRIBUTES </th> <td class="description">Set-Resource-Attributes: Set resource object attributes.</td></tr> |
| <tr><th>IPP_OP_SET_SYSTEM_ATTRIBUTES </th> <td class="description">Set-System-Attributes: Set system object attributes.</td></tr> |
| <tr><th>IPP_OP_SHUTDOWN_ALL_PRINTERS </th> <td class="description">Shutdown-All-Printers: Shutdown all services.</td></tr> |
| <tr><th>IPP_OP_SHUTDOWN_ONE_PRINTER </th> <td class="description">Shutdown-One-Printer: Shutdown a service.</td></tr> |
| <tr><th>IPP_OP_STARTUP_ALL_PRINTERS </th> <td class="description">Startup-All-Printers: Startup all services.</td></tr> |
| <tr><th>IPP_OP_STARTUP_ONE_PRINTER </th> <td class="description">Startup-One-Printer: Start a service.</td></tr> |
| <tr><th>IPP_OP_SUSPEND_CURRENT_JOB </th> <td class="description">Suspend-Current-Job: Suspend the current job</td></tr> |
| <tr><th>IPP_OP_VALIDATE_JOB </th> <td class="description">Validate-Job: Validate job values prior to submission</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3> |
| <p class="description">Orientation values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_ORIENT_LANDSCAPE </th> <td class="description">90 degrees counter-clockwise</td></tr> |
| <tr><th>IPP_ORIENT_NONE </th> <td class="description">No rotation</td></tr> |
| <tr><th>IPP_ORIENT_PORTRAIT </th> <td class="description">No rotation</td></tr> |
| <tr><th>IPP_ORIENT_REVERSE_LANDSCAPE </th> <td class="description">90 degrees clockwise</td></tr> |
| <tr><th>IPP_ORIENT_REVERSE_PORTRAIT </th> <td class="description">180 degrees</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_pstate_e">ipp_pstate_e</a></h3> |
| <p class="description">Printer state values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_PSTATE_IDLE </th> <td class="description">Printer is idle</td></tr> |
| <tr><th>IPP_PSTATE_PROCESSING </th> <td class="description">Printer is working</td></tr> |
| <tr><th>IPP_PSTATE_STOPPED </th> <td class="description">Printer is stopped</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_quality_e">ipp_quality_e</a></h3> |
| <p class="description">Print quality values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_QUALITY_DRAFT </th> <td class="description">Draft quality</td></tr> |
| <tr><th>IPP_QUALITY_HIGH </th> <td class="description">High quality</td></tr> |
| <tr><th>IPP_QUALITY_NORMAL </th> <td class="description">Normal quality</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_res_e">ipp_res_e</a></h3> |
| <p class="description">Resolution units</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_RES_PER_CM </th> <td class="description">Pixels per centimeter</td></tr> |
| <tr><th>IPP_RES_PER_INCH </th> <td class="description">Pixels per inch</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_rstate_e">ipp_rstate_e</a></h3> |
| <p class="description">resource-state values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_RSTATE_ABORTED </th> <td class="description">Resource has been aborted and is pending deletion.</td></tr> |
| <tr><th>IPP_RSTATE_AVAILABLE </th> <td class="description">Resource is available for installation.</td></tr> |
| <tr><th>IPP_RSTATE_CANCELED </th> <td class="description">Resource has been canceled and is pending deletion.</td></tr> |
| <tr><th>IPP_RSTATE_INSTALLED </th> <td class="description">Resource is installed.</td></tr> |
| <tr><th>IPP_RSTATE_PENDING </th> <td class="description">Resource is created but has no data yet.</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_sstate_e">ipp_sstate_e</a></h3> |
| <p class="description">system-state values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_SSTATE_IDLE </th> <td class="description">At least one printer is idle and none are processing a job.</td></tr> |
| <tr><th>IPP_SSTATE_PROCESSING </th> <td class="description">At least one printer is processing a job.</td></tr> |
| <tr><th>IPP_SSTATE_STOPPED </th> <td class="description">All printers are stopped.</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_state_e">ipp_state_e</a></h3> |
| <p class="description">ipp_t state values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_STATE_ATTRIBUTE </th> <td class="description">One or more attributes need to be sent/received</td></tr> |
| <tr><th>IPP_STATE_DATA </th> <td class="description">IPP request data needs to be sent/received</td></tr> |
| <tr><th>IPP_STATE_ERROR </th> <td class="description">An error occurred</td></tr> |
| <tr><th>IPP_STATE_HEADER </th> <td class="description">The request header needs to be sent/received</td></tr> |
| <tr><th>IPP_STATE_IDLE </th> <td class="description">Nothing is happening/request completed</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_status_e">ipp_status_e</a></h3> |
| <p class="description">IPP status code values</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_STATUS_CUPS_INVALID </th> <td class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></td></tr> |
| <tr><th>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </th> <td class="description">client-error-account-authorization-failed</td></tr> |
| <tr><th>IPP_STATUS_ERROR_ACCOUNT_CLOSED </th> <td class="description">client-error-account-closed</td></tr> |
| <tr><th>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </th> <td class="description">client-error-account-info-needed</td></tr> |
| <tr><th>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </th> <td class="description">client-error-account-limit-reached</td></tr> |
| <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </th> <td class="description">client-error-attributes-not-settable</td></tr> |
| <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </th> <td class="description">client-error-attributes-or-values-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_BAD_REQUEST </th> <td class="description">client-error-bad-request</td></tr> |
| <tr><th>IPP_STATUS_ERROR_BUSY </th> <td class="description">server-error-busy</td></tr> |
| <tr><th>IPP_STATUS_ERROR_CHARSET </th> <td class="description">client-error-charset-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_COMPRESSION_ERROR </th> <td class="description">client-error-compression-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </th> <td class="description">client-error-compression-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_CONFLICTING </th> <td class="description">client-error-conflicting-attributes</td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-authorization-failed </td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </th> <td class="description">cups-error-account-closed @deprecate@</td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-info-needed </td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-limit-reached </td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-authentication-canceled - Authentication canceled by user </td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-pki-error - Error negotiating a secure connection </td></tr> |
| <tr><th>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-upgrade-required - TLS upgrade required </td></tr> |
| <tr><th>IPP_STATUS_ERROR_DEVICE </th> <td class="description">server-error-device-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_ACCESS </th> <td class="description">client-error-document-access-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </th> <td class="description">client-error-document-format-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </th> <td class="description">client-error-document-format-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </th> <td class="description">client-error-document-password-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </th> <td class="description">client-error-document-permission-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_SECURITY </th> <td class="description">client-error-document-security-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </th> <td class="description">client-error-document-unprintable-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_FORBIDDEN </th> <td class="description">client-error-forbidden</td></tr> |
| <tr><th>IPP_STATUS_ERROR_GONE </th> <td class="description">client-error-gone</td></tr> |
| <tr><th>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </th> <td class="description">client-error-ignored-all-subscriptions</td></tr> |
| <tr><th>IPP_STATUS_ERROR_INTERNAL </th> <td class="description">server-error-internal-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_JOB_CANCELED </th> <td class="description">server-error-job-canceled</td></tr> |
| <tr><th>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </th> <td class="description">server-error-multiple-document-jobs-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </th> <td class="description">server-error-not-accepting-jobs</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_AUTHENTICATED </th> <td class="description">client-error-not-authenticated</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_AUTHORIZED </th> <td class="description">client-error-not-authorized</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_FETCHABLE </th> <td class="description">client-error-not-fetchable</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_FOUND </th> <td class="description">client-error-not-found</td></tr> |
| <tr><th>IPP_STATUS_ERROR_NOT_POSSIBLE </th> <td class="description">client-error-not-possible</td></tr> |
| <tr><th>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </th> <td class="description">server-error-operation-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </th> <td class="description">server-error-printer-is-deactivated</td></tr> |
| <tr><th>IPP_STATUS_ERROR_REQUEST_ENTITY </th> <td class="description">client-error-request-entity-too-large</td></tr> |
| <tr><th>IPP_STATUS_ERROR_REQUEST_VALUE </th> <td class="description">client-error-request-value-too-long</td></tr> |
| <tr><th>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </th> <td class="description">server-error-service-unavailable</td></tr> |
| <tr><th>IPP_STATUS_ERROR_TEMPORARY </th> <td class="description">server-error-temporary-error</td></tr> |
| <tr><th>IPP_STATUS_ERROR_TIMEOUT </th> <td class="description">client-error-timeout</td></tr> |
| <tr><th>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </th> <td class="description">server-error-too-many-documents</td></tr> |
| <tr><th>IPP_STATUS_ERROR_TOO_MANY_JOBS </th> <td class="description">server-error-too-many-jobs</td></tr> |
| <tr><th>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </th> <td class="description">client-error-too-many-subscriptions</td></tr> |
| <tr><th>IPP_STATUS_ERROR_URI_SCHEME </th> <td class="description">client-error-uri-scheme-not-supported</td></tr> |
| <tr><th>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </th> <td class="description">server-error-version-not-supported</td></tr> |
| <tr><th>IPP_STATUS_OK </th> <td class="description">successful-ok</td></tr> |
| <tr><th>IPP_STATUS_OK_CONFLICTING </th> <td class="description">successful-ok-conflicting-attributes</td></tr> |
| <tr><th>IPP_STATUS_OK_EVENTS_COMPLETE </th> <td class="description">successful-ok-events-complete</td></tr> |
| <tr><th>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </th> <td class="description">successful-ok-ignored-or-substituted-attributes</td></tr> |
| <tr><th>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </th> <td class="description">successful-ok-ignored-subscriptions</td></tr> |
| <tr><th>IPP_STATUS_OK_TOO_MANY_EVENTS </th> <td class="description">successful-ok-too-many-events</td></tr> |
| </tbody></table> |
| <h3 class="enumeration"><a id="ipp_tag_e">ipp_tag_e</a></h3> |
| <p class="description">Value and group tag values for attributes</p> |
| <h4 class="constants">Constants</h4> |
| <table class="list"><tbody> |
| <tr><th>IPP_TAG_ADMINDEFINE </th> <td class="description">Admin-defined value</td></tr> |
| <tr><th>IPP_TAG_BOOLEAN </th> <td class="description">Boolean value</td></tr> |
| <tr><th>IPP_TAG_CHARSET </th> <td class="description">Character set value</td></tr> |
| <tr><th>IPP_TAG_CUPS_INVALID </th> <td class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></td></tr> |
| <tr><th>IPP_TAG_DATE </th> <td class="description">Date/time value</td></tr> |
| <tr><th>IPP_TAG_DEFAULT </th> <td class="description">Default value</td></tr> |
| <tr><th>IPP_TAG_DELETEATTR </th> <td class="description">Delete-attribute value</td></tr> |
| <tr><th>IPP_TAG_DOCUMENT </th> <td class="description">Document group</td></tr> |
| <tr><th>IPP_TAG_END </th> <td class="description">End-of-attributes</td></tr> |
| <tr><th>IPP_TAG_ENUM </th> <td class="description">Enumeration value</td></tr> |
| <tr><th>IPP_TAG_EVENT_NOTIFICATION </th> <td class="description">Event group</td></tr> |
| <tr><th>IPP_TAG_INTEGER </th> <td class="description">Integer value</td></tr> |
| <tr><th>IPP_TAG_JOB </th> <td class="description">Job group</td></tr> |
| <tr><th>IPP_TAG_KEYWORD </th> <td class="description">Keyword value</td></tr> |
| <tr><th>IPP_TAG_LANGUAGE </th> <td class="description">Language value</td></tr> |
| <tr><th>IPP_TAG_MIMETYPE </th> <td class="description">MIME media type value</td></tr> |
| <tr><th>IPP_TAG_NAME </th> <td class="description">Name value</td></tr> |
| <tr><th>IPP_TAG_NAMELANG </th> <td class="description">Name-with-language value</td></tr> |
| <tr><th>IPP_TAG_NOTSETTABLE </th> <td class="description">Not-settable value</td></tr> |
| <tr><th>IPP_TAG_NOVALUE </th> <td class="description">No-value value</td></tr> |
| <tr><th>IPP_TAG_OPERATION </th> <td class="description">Operation group</td></tr> |
| <tr><th>IPP_TAG_PRINTER </th> <td class="description">Printer group</td></tr> |
| <tr><th>IPP_TAG_RANGE </th> <td class="description">Range value</td></tr> |
| <tr><th>IPP_TAG_RESOLUTION </th> <td class="description">Resolution value</td></tr> |
| <tr><th>IPP_TAG_RESOURCE </th> <td class="description">Resource group</td></tr> |
| <tr><th>IPP_TAG_STRING </th> <td class="description">Octet string value</td></tr> |
| <tr><th>IPP_TAG_SUBSCRIPTION </th> <td class="description">Subscription group</td></tr> |
| <tr><th>IPP_TAG_SYSTEM </th> <td class="description">System group</td></tr> |
| <tr><th>IPP_TAG_TEXT </th> <td class="description">Text value</td></tr> |
| <tr><th>IPP_TAG_TEXTLANG </th> <td class="description">Text-with-language value</td></tr> |
| <tr><th>IPP_TAG_UNKNOWN </th> <td class="description">Unknown value</td></tr> |
| <tr><th>IPP_TAG_UNSUPPORTED_GROUP </th> <td class="description">Unsupported attributes group</td></tr> |
| <tr><th>IPP_TAG_UNSUPPORTED_VALUE </th> <td class="description">Unsupported value</td></tr> |
| <tr><th>IPP_TAG_URI </th> <td class="description">URI value</td></tr> |
| <tr><th>IPP_TAG_URISCHEME </th> <td class="description">URI scheme value</td></tr> |
| <tr><th>IPP_TAG_ZERO </th> <td class="description">Zero tag - used for separators</td></tr> |
| </tbody></table> |
| </div> |
| </body> |
| </html> |
