getOption Method
Returns the value of one of the following options:
SXH_OPTION_URL
(Read-only.)SXH_OPTION_URL_CODEPAGE
SXH_OPTION_ESCAPE_PERCENT_IN_URL
SXH_OPTION_IGNORE_SERVER_SSL_CERT_ERROR_FLAGS
SXH_OPTION_SELECT_CLIENT_SSL_CERT
Fore more information about these options, see Remarks.
Script Syntax
varValue = oServerXMLHTTPRequest.getOption(option);
Parameters
- option
- The option whose value is to be returned.
Visual Basic Syntax
varValue = oServerXMLHTTPRequest.getOption(option)
- option
- The option whose value is to be returned.
C/C++ Syntax
HRESULT getOption(SERVERXMLHTTP_OPTION option, VARIANT * value);
Parameters
- option [in]
- The option whose value is to be returned.
- value [out, retval]
- The return value of the option.
C/C++ Return Values
- S_OK
- Value returned if successful.
Remarks
The following table lists the options available for the getOption
method.
Option | Description |
---|---|
-1 |
SXH_OPTION_URL
By default, returns a variant of type string that contains the URL of the resource. Read-only. The |
0 |
SXH_OPTION_URL_CODEPAGE
By default, CP_UTF8 is the code page used to convert the Unicode URL string (specified in the The |
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 |
2 |
SXH_OPTION_IGNORE_SERVER_SSL_CERT_ERROR_FLAGS
The
Unknown certificate authority
Malformed certificate such as a certificate with no subject name.
Mismatch between the visited hostname and the certificate name being used on the server.
The date in the certificate is invalid or has expired.
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 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 certName = shx.getOption(3) = "MSXML" |
To view reference information for Visual Basic, C/C++, or Script only, click the Language Filter button in the upper-left corner of the page.
See Also
open Method (ServerXMLHTTP/IServerXMLHTTPRequest) | setOption Method
Applies to: IServerXMLHTTPRequest/ServerXMLHTTP