| |
| INT SetOption( |
| |
DWORD dwOption, |
|
| |
BOOL bEnabled |
|
| ); |
The SetOption method enables or disables the specified
option.
Parameters
- hClient
- Handle to the client session.
- dwOption
- An unsigned integer which specifies one of the following
options:
| Constant |
Description |
| HTTP_OPTION_NOCACHE |
This instructs the server to not return a cached copy of
the resource. When connected to an HTTP 1.0 or earlier server,
this directive may be ignored. |
| HTTP_OPTION_KEEPALIVE |
This instructs the server to maintain a persistent
connection between requests. This can improve performance
because it eliminates the need to establish a separate
connection for each resource that is requested. If the server
does not support the keep-alive option, the client will
automatically reconnect when each resource is requested.
Although it will not provide any performance benefits, this
allows the option to be used with all servers. |
| HTTP_OPTION_REDIRECT |
This option specifies the client should automatically
handle resource redirection. If the server indicates that the
requested resource has moved to a new location, the client will
close the current connection and request the resource from the
new location. Note that it is possible that the redirected
resource will be located on a different server. |
| HTTP_OPTION_NOUSERAGENT |
This option specifies the client should not include a
User-Agent header with any requests made during the session. The
user agent is a string which is used to identify the client
application to the server. |
| HTTP_OPTION_ERRORDATA |
This option specifies the client should return the
content of an error response from the server, rather than
returning an error code. Note that this option will disable
automatic resource redirection, and should not be used with
HTTP_OPTION_REDIRECT. |
| HTTP_OPTION_FREETHREAD |
This option specifies the handle returned by this
function may be used by any thread, and is not limited to the
thread which created it. The application is responsible for
ensuring that access to the handle is synchronized across
multiple threads. |
| HTTP_OPTION_HIRES_TIMER |
This option specifies the elapsed time for data
transfers should be returned in milliseconds instead of seconds.
This will return more accurate transfer times for smaller
amounts of data over fast network connections. |
- bEnabled
- An integer value which determines if the option should be
enabled or disabled. A non-zero value specifies that the option
should be enabled, while a zero value specifies that the option
should be disabled.
Return Value
If the method succeeds, the return value is zero. If the method
fails, the return value is HTTP_ERROR. To get extended error
information, call GetLastError.
Remarks
The SetOption method can only enable or
disable the options listed above. Other options are only available
when the connection is initially established. For example, you cannot
use this function to enable security options after the connection
has been made.
If you use HTTP_OPTION_FREETHREAD to permit any thread to reference
a client handle allocated in another thread, your application is
responsible for ensuring it does not attempt to submit requests using
the same handle on different threads at the same time. If two different
threads attempt to perform an operation using the same handle, there
is no guarantee as to which thread will complete the operation first.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: cshtpv10.lib
See Also
Connect,
GetOption,
ProxyConnect
|
|