HttpQueryServiceConfiguration 関数 (http.h)

  • [アーティクル]

HttpQueryServiceConfiguration 関数は、1 つ以上の HTTP Server API 構成レコードを取得します。

構文

HTTPAPI_LINKAGE ULONG HttpQueryServiceConfiguration(
  [in]                HANDLE                 ServiceHandle,
  [in]                HTTP_SERVICE_CONFIG_ID ConfigId,
  [in, optional]      PVOID                  pInput,
  [in, optional]      ULONG                  InputLength,
  [in, out, optional] PVOID                  pOutput,
  [in, optional]      ULONG                  OutputLength,
  [out, optional]     PULONG                 pReturnLength,
  [in]                LPOVERLAPPED           pOverlapped
);

パラメーター

[in] ServiceHandle

予約済み。 ゼロを指定してください。

[in] ConfigId

構成レコードのクエリの種類。 このパラメーターは、 から次のいずれかの値です。
列挙HTTP_SERVICE_CONFIG_ID 。

ConfigId 値 意味
HttpServiceConfigIPListenList
 IP リッスン リストに対してクエリを実行します。
HttpServiceConfigSSLCertInfo
 SSL ストアに対して特定の証明書レコードのクエリを実行します。
HttpServiceConfigUrlAclInfo
 URL 予約情報を照会します。
HttpServiceConfigTimeout
 HTTP Server API 全体の接続タイムアウトを照会します。

Windows Vista 以降: この列挙はサポートされています。
HttpServiceConfigSslSniCertInfo
 SSL サーバー名表示 (SNI) ストアに対して、特定の証明書レコードのクエリを実行します。

Windows 8 以降: この列挙値がサポートされています。
HttpServiceConfigSslCcsCertInfo
 ポート上の SSL 一元化証明書ストア (CCS) レコードの SSL 構成を照会します。 ポートは、pInputConfigInfo パラメーターに渡すHTTP_SERVICE_CONFIG_SSL_CCS_QUERY構造体の KeyDesc メンバーによって指定されます。

Windows 8 以降: この列挙値がサポートされています。

[in, optional] pInput

次の表の ConfigId に関連付けられるクエリと型の内容をさらに定義する構造体へのポインター。

ConfigId 値 意味
HttpServiceConfigIPListenList
 入力データがありません。NULL に設定 します。
HttpServiceConfigSSLCertInfo

HTTP_SERVICE_CONFIG_SSL_QUERY 構造体。
HttpServiceConfigUrlAclInfo

HTTP_SERVICE_CONFIG_URLACL_QUERY 構造体。
HttpServiceConfigTimeout

HTTP_SERVICE_CONFIG_TIMEOUT_KEY 構造体。

Windows Vista 以降: この構造体はサポートされています。
HttpServiceConfigSslSniCertInfo

HTTP_SERVICE_CONFIG_SSL_SNI_QUERY 構造体。

Windows 8 以降: この構造体はサポートされています。
HttpServiceConfigSslCcsCertInfo

HTTP_SERVICE_CONFIG_SSL_CCS_QUERY 構造体。

Windows 8 以降: この構造体はサポートされています。
 

詳細については、適切なクエリ構造に関するページを参照してください。

[in, optional] InputLength

pInputConfigInfo バッファーのサイズ (バイト単位)。

[in, out, optional] pOutput

クエリ結果が返されるバッファーへのポインター。 このバッファーの型は ConfigId と関連付けます。

ConfigId 値 意味
HttpServiceConfigIPListenList

HTTP_SERVICE_CONFIG_IP_LISTEN_QUERY 構造体。
HttpServiceConfigSSLCertInfo

HTTP_SERVICE_CONFIG_SSL_SET 構造体。
HttpServiceConfigUrlAclInfo

HTTP_SERVICE_CONFIG_URLACL_SET 構造体。
HttpServiceConfigTimeout

データ型HTTP_SERVICE_CONFIG_TIMEOUT_PARAM します。

Windows Vista 以降: この構造体はサポートされています。
HttpServiceConfigSslSniCertInfo

HTTP_SERVICE_CONFIG_SSL_SNI_SET 構造体。

Windows 8 以降: この構造体はサポートされています。
HttpServiceConfigSslCcsCertInfo

HTTP_SERVICE_CONFIG_SSL_CCS_SET 構造体。

Windows 8 以降: この構造体はサポートされています。

[in, optional] OutputLength

pOutputConfigInfo バッファーのサイズ (バイト単位)。

[out, optional] pReturnLength

出力バッファーに書き込まれるバイト数を受け取る変数へのポインター。 出力バッファーが小さすぎると、 ERROR_INSUFFICIENT_BUFFERの戻り値で呼び出しが失敗します。 pReturnLength が指す値を使用して、バッファーが呼び出しを成功させるために必要な最小長を決定できます。

[in] pOverlapped

非同期操作用に予約されており、 NULL に設定する必要があります。

戻り値

関数が成功した場合、戻り値は NO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

値 意味
ERROR_INVALID_PARAMETER
 パラメーターの 1 つが無効です。
ERROR_INSUFFICIENT_BUFFER
 pOutputConfigInfo が指すバッファーが小さすぎて、出力データを受信できません。 終了時に pReturnLength が指すサイズと同じ大きさのバッファーを使用して、関数を再度呼び出します。
ERROR_MORE_DATA
 pOutputConfigInfo が指すバッファーが小さすぎて、出力データを受信できません。 終了時に pReturnLength が指すサイズと同じ大きさのバッファーを使用して、関数を再度呼び出します。
ERROR_NO_MORE_ITEMS
 指定した条件を満たす項目はこれ以上返されません。
その他
 WinError.h で定義されている システム エラー コード 。

要件

   
サポートされている最小のクライアント Windows Vista、WINDOWS XP と SP2 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー http.h
Library Httpapi.lib
[DLL] Httpapi.dll

こちらもご覧ください

HTTP Server API バージョン 1.0 関数

HttpDeleteServiceConfiguration

HttpSetServiceConfiguration

HttpUpdateServiceConfiguration