refreqtarget.html 3.8 KB

1234567891011121314
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>ne_get_request_target</title><link rel="stylesheet" type="text/css" href="manual.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="neon HTTP/WebDAV client library"><link rel="up" href="ref.html" title="neon API reference"><link rel="prev" href="refreqbody.html" title="ne_set_request_body_buffer"><link rel="next" href="refred.html" title="ne_redirect_register"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ne_get_request_target</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="refreqbody.html">Prev</a> </td><th width="60%" align="center">neon API reference</th><td width="20%" align="right"> <a accesskey="n" href="refred.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="refreqtarget"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ne_get_request_target — retrieve request target</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include &lt;ne_request.h&gt;</pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">const ne_uri *<b class="fsfunc">ne_get_request_target</b>(</code></td><td>ne_request *<var class="pdparam">req</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="id3609"></a><h2>Description</h2><p>The <code class="function">ne_get_request_target</code> returns the
  2. request target URI as a pointer to an
  3. <span class="structname">ne_uri</span> object. The "target resource" of a
  4. request is defined per <a class="ulink" href="https://www.rfc-editor.org/rfc/rfc9110.html#section-7.1" target="_top">Section
  5. 7.1 of RFC 9110</a> and is derived from the parameters used to
  6. create the request with <a class="xref" href="refreq.html#ne_request_create">ne_request_create</a> and
  7. the parameters used to create the session with <a class="xref" href="refsess.html#ne_session_create">ne_session_create</a>.</p></div><div class="refsect1"><a name="id3617"></a><h2>Return value</h2><p>The <code class="function">ne_get_request_target</code> function
  8. returns a <span class="structname">ne_uri</span>, or <code class="literal">NULL</code> if it was not
  9. possible to create the target URI. The latter can only occur if
  10. the path used to create the request object was not a valid URI
  11. path. Note that the <em class="structfield"><code>path</code></em> field of the
  12. returned object can be the empty string if the
  13. <code class="literal">authority-form</code> of the URI is used.</p></div><div class="refsect1"><a name="id3625"></a><h2>History</h2><p><code class="function">ne_get_request_target</code> is available in
  14. neon 0.34.0 and later.</p></div><div class="refsect1"><a name="id3629"></a><h2>See also</h2><p><a class="xref" href="refreq.html#ne_request_create">ne_request_create</a>, <a class="xref" href="refsess.html#ne_session_create">ne_session_create</a>.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="refreqbody.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="refred.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ne_set_request_body_buffer </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> ne_redirect_register</td></tr></table></div></body></html>