winscp/libs/neon/doc/html/refreqflags.html

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>ne_set_request_flag</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="refopts.html" title="ne_set_useragent"><link rel="next" href="refreqbody.html" title="ne_set_request_body_buffer"></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_set_request_flag</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="refopts.html">Prev</a> </td><th width="60%" align="center">neon API reference</th><td width="20%" align="right"> <a accesskey="n" href="refreqbody.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="refreqflags"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ne_set_request_flag, ne_get_request_flag — set and retrieve per-request flags</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include &lt;ne_request.h&gt;</pre><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">void <b class="fsfunc">ne_set_request_flag</b>(</code>ne_request *<var xmlns="" class="pdparam">req</var>, ne_request_flag <var xmlns="" class="pdparam">flag</var>, int <var xmlns="" class="pdparam">value</var><code xmlns="">)</code>;</code></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="funcprototype"><code><code xmlns="" class="funcdef">int <b class="fsfunc">ne_get_request_flag</b>(</code>ne_request *<var xmlns="" class="pdparam">req</var>, ne_request_flag <var xmlns="" class="pdparam">flag</var><code xmlns="">)</code>;</code></div></div></div><div class="refsect1"><a name="id3733"></a><h2>Description</h2><p>The <code class="function">ne_set_request_flag</code> function
    enables or disables a per-request flag.  Passing a non-zero
    <code class="parameter">value</code> argument enables the flag, and zero
    disables it.</p><p>The following flags are defined:</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top"><col></colgroup><tbody><tr><td><p><span class="term"><code class="constant">NE_REQFLAG_EXPECT100</code> (default off)</span></p></td><td>enable this flag to use the "Expect:
	      100-continue" feature of HTTP/1.1, which allows the
	      server to process request headers without reading the
	      entire request body.  This saves time and bandwidth if
	      the server gives an authentication challenge (requiring
	      the request to be resent), but has interoperability
	      problems with some older servers.</td></tr><tr><td><p><span class="term"><code class="constant">NE_REQFLAG_IDEMPOTENT</code>  (default on)</span></p></td><td>disable this flag if the request uses a
	      non-idempotent method such as
	      <code class="literal">POST</code></td></tr><tr><td><p><span class="term"><code class="constant">NE_REQFLAG_1XXTIMEOUT</code> (default on)</span></p></td><td>disable this flag to disable overall timeout
	      when reading interim (1xx) responses</td></tr></tbody></table></div></div><div class="refsect1"><a name="id3756"></a><h2>Return value</h2><p>The <code class="function">ne_get_request_flag</code> function returns
    zero if a flag is disabled, less than zero if the flag is not
    supported, or greater than zero if the flag is enabled.</p></div><div class="refsect1"><a name="id3760"></a><h2>See also</h2><p><a class="xref" href="refreq.html#ne_request_create">ne_request_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="refopts.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="refreqbody.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ne_set_useragent </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> ne_set_request_body_buffer</td></tr></table></div></body></html>