WinHttpRequestOption 列挙

[アーティクル]
06/13/2023

WinHttpRequestOption 列挙には、現在の Microsoft Windows HTTP サービス (WinHTTP) セッションに対して設定または取得できるオプションが含まれています。

構文

typedef enum WinHttpRequestOption { 
  WinHttpRequestOption_UserAgentString,
  WinHttpRequestOption_URL,
  WinHttpRequestOption_URLCodePage,
  WinHttpRequestOption_EscapePercentInURL,
  WinHttpRequestOption_SslErrorIgnoreFlags,
  WinHttpRequestOption_SelectCertificate,
  WinHttpRequestOption_EnableRedirects,
  WinHttpRequestOption_UrlEscapeDisable,
  WinHttpRequestOption_UrlEscapeDisableQuery,
  WinHttpRequestOption_SecureProtocols,
  WinHttpRequestOption_EnableTracing,
  WinHttpRequestOption_RevertImpersonationOverSsl,
  WinHttpRequestOption_EnableHttpsToHttpRedirects,
  WinHttpRequestOption_EnablePassportAuthentication,
  WinHttpRequestOption_MaxAutomaticRedirects,
  WinHttpRequestOption_MaxResponseHeaderSize,
  WinHttpRequestOption_MaxResponseDrainSize,
  WinHttpRequestOption_EnableHttp1_1,
  WinHttpRequestOption_EnableCertificateRevocationCheck
} WinHttpRequestOption;

定数

WinHttpRequestOption_UserAgentString

ユーザーエージェント文字列を含む VARIANT を設定または取得します。

WinHttpRequestOption_URL

リソースの URL を含む VARIANT を 取得します。この値は読み取り専用です。このプロパティを使用して URL を設定することはできません。 Open メソッドが呼び出されるまで、URL を読み取ることはできません。このオプションは、 Send メソッドが完了した後に URL を確認し、リダイレクトが発生したことを確認する場合に便利です。

WinHttpRequestOption_URLCodePage

URL 文字列のコードページを識別する VARIANT を設定または取得します。既定値は UTF-8 コードページです。コードページを使用して、 Open メソッドで渡される Unicode URL 文字列を 1 バイトの文字列表現に変換します。

WinHttpRequestOption_EscapePercentInURL

URL 文字列内のパーセント文字がエスケープシーケンスに変換されるかどうかを示す VARIANT を 設定または取得します。このオプションの既定値は VARIANT_TRUE です。これは、パーセント記号を除くすべての安全でない米国標準協会 (ANSI) 文字をエスケープシーケンスに変換することを指定します。

WinHttpRequestOption_SslErrorIgnoreFlags

どのサーバー証明書エラーを無視するかを示す VARIANT を 設定または取得します。これは、次のフラグの 1 つ以上の組み合わせにすることができます。

エラー	値
不明な証明機関 (CA) または信頼されていないルート	0x0100
間違った使用法	0x0200
共通名 (CN) が無効です	0x1000
無効な日付または証明書の有効期限が切れています	0x2000

WinHTTP のバージョン 5.1 のこのオプションの既定値は 0 であるため、エラーは無視されません。以前のバージョンの WinHTTP では、既定の設定が0x3300されたため、すべてのサーバー証明書エラーが既定で無視されました。

WinHttpRequestOption_SelectCertificate

認証のためにサーバーに送信されるクライアント証明書を指定する VARIANT を 設定します。このオプションは、バックスラッシュで区切られたクライアント証明書の場所、 証明書ストア、およびサブジェクトを示します。クライアント証明書の選択の詳細については、「 WinHTTP の SSL」を参照してください。

WinHttpRequestOption_EnableRedirects

サーバーがリソースの新しい場所を指定したときに要求が自動的にリダイレクトされるかどうかを示す VARIANT を 設定または取得します。このオプションの既定値は、要求が自動的にリダイレクトされることを示すために VARIANT_TRUE されます。

WinHttpRequestOption_UrlEscapeDisable

URL のパスおよびクエリコンポーネント内の安全でない文字をエスケープシーケンスに変換するかどうかを示す VARIANT を 設定または取得します。このオプションの既定値は VARIANT_TRUEで、パスとクエリの文字を変換することを指定します。

WinHttpRequestOption_UrlEscapeDisableQuery

URL のクエリコンポーネント内の安全でない文字をエスケープシーケンスに変換するかどうかを示す VARIANT を 設定または取得します。このオプションの既定値は VARIANT_TRUEで、クエリ内の文字を変換することを指定します。

WinHttpRequestOption_SecureProtocols

使用できるセキュリティで保護されたプロトコルを示す VARIANT を 設定または取得します。このオプションは、クライアントが受け入れ可能なプロトコルを選択します。プロトコルは、Secure Sockets Layer (SSL) ハンドシェイク中にネゴシエートされます。これは、次のフラグの 1 つ以上の組み合わせにすることができます。

Protocol	値
SSL 2.0	0x0008
SSL 3.0	0x0020
トランスポート層セキュリティ (TLS) 1.0	0x0080

このオプションの既定値は 0x0028 です。これは、SSL 2.0 または SSL 3.0 を使用できることを示します。このオプションが 0 に設定されている場合、クライアントとサーバーは受け入れ可能なセキュリティプロトコルを決定できず、次に送信するとエラーが発生します。

WinHttpRequestOption_EnableTracing

トレースが現在有効になっているかどうかを示す VARIANT を 設定または取得します。 WinHTTP トレースの収集に関するページも参照してください。

WinHttpRequestOption_RevertImpersonationOverSsl

WinHttpRequest オブジェクトが SSL 証明書認証操作の間、クライアントの偽装を一時的に元に戻すかどうかを制御します。 WinHttpRequest オブジェクトの既定の設定は TRUE です。証明書認証操作の実行中に偽装を維持するには、このオプションを FALSE に 設定します。

WinHttpRequestOption_EnableHttpsToHttpRedirects

WinHTTP でリダイレクトを許可するかどうかを制御します。既定では、セキュリティで保護された (https) URL から非セキュリティ (http) URL に転送されるリダイレクトを除き、すべてのリダイレクトが自動的に実行されます。 HTTPS から HTTP へのリダイレクトを有効にするには、このオプションを TRUE に 設定します。

WinHttpRequestOption_EnablePassportAuthentication

Passport 認証のサポートを有効または無効にします。既定では、Passport 認証の自動サポートは無効になっています。Passport 認証のサポートを有効にするには、このオプションを TRUE に 設定します。

WinHttpRequestOption_MaxAutomaticRedirects

WinHTTP がフォローするリダイレクトの最大数を設定または取得します。既定値は 10 です。この制限により、許可されていないサイトが多数のリダイレクトに続いて WinHTTP クライアントを停止することを防ぐことができます。