Microsoft XML Core Services (MSXML) 5.0 for Microsoft Office - DOM Reference

setOption Method

Sets one of the following options:

For more information about these options, see Remarks.

[Script]

Script Syntax

oServerXMLHTTPRequest.setOption(option, value);

Parameters

option
The option whose value is to be set.
value
The value to which the specified option is to be set.
[Visual Basic]

Visual Basic Syntax

oServerXMLHTTPRequest.setOption(option, value)

Parameters

option
The option whose value is to be set.
value
The value to which the specified option is to be set.
[C/C++]

C/C++ Syntax

HRESULT setOption(SERVERXMLHTTP_OPTION option, VARIANT value);

Parameters

option [in]
The option whose value is to be set.
value [in]
The value to which the specified option is to be set.

C/C++ Return Values

S_OK
Value returned if successful.

To view reference information for Visual Basic, C/C++, or Script only, click the Language Filter button Language Filter in the upper-left corner of the page.

Remarks

The following table lists the options available to the setOption method.

Option Description
0 SXH_OPTION_URL_CODEPAGE

By default, CP_UTF8 is the code page used to convert the Unicode URL string (specified in the open method) to a single-byte representation.

The SXH_OPTION_URL_CODEPAGE option allows the client to override this default with a different code page value. The client should specify an unsigned integer value for the code page.
1 SXH_OPTION_ESCAPE_PERCENT_IN_URL

By default, escaping unsafe ANSI characters in the URL (for example, " " -> "%20") does not escape the % character itself.

The SXH_OPTION_ESCAPE_PERCENT_IN_URL option allows the client to change this behavior. The client should specify a Boolean True/False value for this option.
2 SXH_OPTION_IGNORE_SERVER_SSL_CERT_ERROR_FLAGS

The SXH_OPTION_IGNORE_SERVER_SSL_CERT_ERROR_FLAGS option is a DWORD mask of various flags that can be set to change this default behavior. The default value is to ignore all problems. You must set this option before calling the send method. The flags are as follows:

SXH_SERVER_CERT_IGNORE_UNKNOWN_CA = 256

Unknown certificate authority

SXH_SERVER_CERT_IGNORE_WRONG_USAGE = 512

Malformed certificate such as a certificate with no subject name.

SXH_SERVER_CERT_IGNORE_CERT_CN_INVALID = 4096

Mismatch between the visited hostname and the certificate name being used on the server.

SXH_SERVER_CERT_IGNORE_CERT_DATE_INVALID = 8192

The date in the certificate is invalid or has expired.

SXH_SERVER_CERT_IGNORE_ALL_SERVER_ERRORS = 13056

All certificate errors.

To turn off a flag, you subtract it from the default value, which is the sum of all flags. For example, to catch an invalid date in a certificate, you turn off the SXH_SERVER_CERT_IGNORE_CERT_DATE_INVALID flag as follows:

shx.setOption(2, shx.getOption(2) _
                    - SXH_SERVER_CERT_IGNORE_CERT_DATE_INVALID)
3 SXH_OPTION_SELECT_CLIENT_SSL_CERT

By default, the value of this option is an empty string (""), which means pick the first certificate in the local store to send if the server requests a client certificate.

The SXH_OPTION_SELECT_CLIENT_SSL_CERT option is a string that lets you select which client certificate from the local store should be sent. You must set this option before calling the send method. The following example sets the client certificate option to request the client certificate named "MSXML":

shx.setOption(3, "MSXML")

Note   Option –1, SXH_OPTION_URL, is a read-only return value, and can therefore not be set by the setOption method. For more information about this option, see getOption Method.

See Also

open Method

Applies to: IServerXMLHTTPRequest/ServerXMLHTTP