Merge pull request #5621 from zdohnal/cgigetarray-sigsegv

[thirdparty/cups.git] / doc / help / api-admin.html
diff --git a/doc/help/api-admin.html b/doc/help/api-admin.html

index 10336b6c5ef76c2677edc4b4f161c93d3e3773b3..7e6b407024e14a2f4a48385448e8a8a60d9756aa 100644 (file)
--- a/doc/help/api-admin.html
+++ b/doc/help/api-admin.html
@@ -1,11 +1,11 @@
-<!doctype html>
+<!DOCTYPE html>
  <html>
  <!-- SECTION: Programming -->
    <head>
      <title>Administration APIs</title>
      <meta name="keywords" content="Programming">
      <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
-    <meta name="creator" content="Mini-XML v2.11">
+    <meta name="creator" content="codedoc v3.2">
      <meta name="author" content="Unknown">
      <meta name="copyright" content="Unknown">
      <meta name="version" content="0.0">
@@ -18,6 +18,11 @@ H1, H2, H3, H4, H5, H6, P, TD, TH {
    font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  }
  
+H1 { font-size: 2em; }
+H2 { font-size: 1.75em; }
+H3 { font-size: 1.5em; }
+H4 { font-size: 1.25em; }
+
  KBD {
    font-family: monaco, courier, monospace;
    font-weight: bold;
@@ -360,14 +365,13 @@ h1, h2, h3, h4, h5, h6 {
  blockquote {
    border: solid thin gray;
    box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
-  padding: 0px 10px;
+  padding: 10px 10px 0px;
    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;
@@ -390,12 +394,19 @@ span.info {
    font-weight: bold;
    white-space: nowrap;
  }
-h3 span.info, h4 span.info {
-  border-top-left-radius: 10px;
-  border-top-right-radius: 10px;
+h2 span.info, h3 span.info, h4 span.info {
+  border-radius: 10px;
    float: right;
+  font-size: 80%;
    padding: 3px 6px;
  }
+h2.title span.info, h3.title span.info, h4.title span.info {
+  border-bottom-left-radius: 0px;
+  border-bottom-right-radius: 0px;
+}
+h2.title span.info {
+  padding: 4px 6px;
+}
  ul.code, ul.contents, ul.subcontents {
    list-style-type: none;
    margin: 0;
@@ -439,6 +450,7 @@ h3.title {
  --></style>
    </head>
    <body>
+    <div class="header">
  <!--
    Administrative API header for CUPS.
  
@@ -470,6 +482,7 @@ h3.title {
  </tr>
  </tbody>
  </table></div>
+    </div>
      <div class="contents">
        <h2 class="title">Contents</h2>
        <ul class="contents">
@@ -503,7 +516,7 @@ h3.title {
  
  <p>The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.</p>
  
-<blockquote><b>Note:<b>
+<blockquote><b>Note:</b>
    <p>Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!</p>
  </blockquote>
  
@@ -657,7 +670,7 @@ int cupsAdminSetServerSettings(http_t *http, int num_settings, cups_option_t *se
  </tbody></table>
  <h4 class="returnvalue">Return Value</h4>
          <p class="description">1 on success, 0 on failure</p>
-<h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="cupsGetDevices">cupsGetDevices</a></h3>
+<h3 class="function"><span class="info">&#160;DEPRECATED&#160;</span><a id="cupsGetDevices">cupsGetDevices</a></h3>
          <p class="description">Get available printer devices.</p>
  <p class="code">
  ipp_status_t cupsGetDevices(http_t *http, int timeout, const char *include_schemes, const char *exclude_schemes, <a href="#cups_device_cb_t">cups_device_cb_t</a> callback, void *user_data);</p>
@@ -683,7 +696,10 @@ ipp_status_t cupsGetDevices(http_t *http, int timeout, const char *include_schem
  devices to the specified callback function. The &quot;timeout&quot; parameter controls
  how long the request lasts, while the &quot;include_schemes&quot; and &quot;exclude_schemes&quot;
  parameters provide comma-delimited lists of backends to include or omit from
-the request respectively.
+the request respectively.<br>
+<br>
+This function is deprecated with the IPP printer discovery functionality
+being provided by the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> and @cupsGetDests@ functions.
  
  </p>
        <h2 class="title"><a id="TYPES">Data Types</a></h2>