doc/html/appdev/refs/api/krb5_set_kdc_recv_hook.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8     <title>krb5_set_kdc_recv_hook - Set a KDC post-receive hook function. &#8212; MIT Kerberos Documentation</title>
   9     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  10     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  11     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  12     <script type="text/javascript">
  13       var DOCUMENTATION_OPTIONS = {
  14         URL_ROOT:    '../../../',
  15         VERSION:     '1.20.1',
  16         COLLAPSE_INDEX: false,
  17         FILE_SUFFIX: '.html',
  18         HAS_SOURCE:  true,
  19         SOURCELINK_SUFFIX: '.txt'
  20       };
  21     </script>
  22     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  23     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  24     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  25     <link rel="author" title="About these documents" href="../../../about.html" />
  26     <link rel="index" title="Index" href="../../../genindex.html" />
  27     <link rel="search" title="Search" href="../../../search.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <link rel="next" title="krb5_set_kdc_send_hook - Set a KDC pre-send hook function." href="krb5_set_kdc_send_hook.html" />
  30     <link rel="prev" title="krb5_set_error_message - Set an extended error message for an error code." href="krb5_set_error_message.html" />
  31   </head>
  32   <body>
  33     <div class="header-wrapper">
  34         <div class="header">
  35
  36
  37             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  38
  39             <div class="rel">
  40
  41         <a href="../../../index.html" title="Full Table of Contents"
  42             accesskey="C">Contents</a> |
  43         <a href="krb5_set_error_message.html" title="krb5_set_error_message - Set an extended error message for an error code."
  44             accesskey="P">previous</a> |
  45         <a href="krb5_set_kdc_send_hook.html" title="krb5_set_kdc_send_hook - Set a KDC pre-send hook function."
  46             accesskey="N">next</a> |
  47         <a href="../../../genindex.html" title="General Index"
  48             accesskey="I">index</a> |
  49         <a href="../../../search.html" title="Enter search criteria"
  50             accesskey="S">Search</a> |
  51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_set_kdc_recv_hook -  Set a KDC post-receive hook function.">feedback</a>
  52             </div>
  53         </div>
  54     </div>
  55
  56     <div class="content-wrapper">
  57       <div class="content">
  58         <div class="document">
  59
  60       <div class="documentwrapper">
  61         <div class="bodywrapper">
  62           <div class="body" role="main">
  63
  64   <div class="section" id="krb5-set-kdc-recv-hook-set-a-kdc-post-receive-hook-function">
  65 <h1>krb5_set_kdc_recv_hook -  Set a KDC post-receive hook function.<a class="headerlink" href="#krb5-set-kdc-recv-hook-set-a-kdc-post-receive-hook-function" title="Permalink to this headline">¶</a></h1>
  66 <dl class="function">
  67 <dt id="c.krb5_set_kdc_recv_hook">
  68 void <code class="descname">krb5_set_kdc_recv_hook</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em>&nbsp;context</em>, <a class="reference internal" href="../types/krb5_post_recv_fn.html#c.krb5_post_recv_fn" title="krb5_post_recv_fn">krb5_post_recv_fn</a><em>&nbsp;recv_hook</em>, void *<em>&nbsp;data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_kdc_recv_hook" title="Permalink to this definition">¶</a></dt>
  69 <dd></dd></dl>
  70
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - The library context.</p>
  76 <p><strong>[in]</strong> <strong>recv_hook</strong> - Hook function (or NULL to disable the hook)</p>
  77 <p class="last"><strong>[in]</strong> <strong>data</strong> - Callback data to be passed to <em>recv_hook</em></p>
  78 </td>
  79 </tr>
  80 </tbody>
  81 </table>
  82 <blockquote>
  83 <div><em>recv_hook</em> will be called after a reply is received from a KDC during a call to a library function such as <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> . The hook function may inspect or override the reply. This hook will not be executed if the pre-send hook returns a synthetic reply.</div></blockquote>
  84 <div class="admonition note">
  85 <p class="first admonition-title">Note</p>
  86 <p class="last">New in 1.15</p>
  87 </div>
  88 </div>
  89
  90
  91           </div>
  92         </div>
  93       </div>
  94         </div>
  95         <div class="sidebar">
  96     <h2>On this page</h2>
  97     <ul>
  98 <li><a class="reference internal" href="#">krb5_set_kdc_recv_hook -  Set a KDC post-receive hook function.</a></li>
  99 </ul>
 100
 101     <br/>
 102     <h2>Table of contents</h2>
 103     <ul class="current">
 104 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 106 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 107 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 108 <li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
 109 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 110 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 111 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 112 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 113 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 114 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 115 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 116 </ul>
 117 </li>
 118 </ul>
 119 </li>
 120 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 121 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 123 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 124 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 125 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 126 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 127 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 128 </ul>
 129
 130     <br/>
 131     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 132     <h4>Search</h4>
 133     <form class="search" action="../../../search.html" method="get">
 134       <input type="text" name="q" size="18" />
 135       <input type="submit" value="Go" />
 136       <input type="hidden" name="check_keywords" value="yes" />
 137       <input type="hidden" name="area" value="default" />
 138     </form>
 139         </div>
 140         <div class="clearer"></div>
 141       </div>
 142     </div>
 143
 144     <div class="footer-wrapper">
 145         <div class="footer" >
 146             <div class="right" ><i>Release: 1.20.1</i><br />
 147                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2022, MIT.
 148             </div>
 149             <div class="left">
 150
 151         <a href="../../../index.html" title="Full Table of Contents"
 152             >Contents</a> |
 153         <a href="krb5_set_error_message.html" title="krb5_set_error_message - Set an extended error message for an error code."
 154             >previous</a> |
 155         <a href="krb5_set_kdc_send_hook.html" title="krb5_set_kdc_send_hook - Set a KDC pre-send hook function."
 156             >next</a> |
 157         <a href="../../../genindex.html" title="General Index"
 158             >index</a> |
 159         <a href="../../../search.html" title="Enter search criteria"
 160             >Search</a> |
 161     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_set_kdc_recv_hook -  Set a KDC post-receive hook function.">feedback</a>
 162             </div>
 163         </div>
 164     </div>
 165
 166   </body>
 167 </html>