ホーム › Networking.HttpServer › HttpQueryRequestQueueProperty

HttpQueryRequestQueueProperty

関数

リクエストキューのプロパティを取得する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// HTTPAPI.dll
#include <windows.h>

DWORD HttpQueryRequestQueueProperty(
    HANDLE RequestQueueHandle,
    HTTP_SERVER_PROPERTY Property,
    void* PropertyInformation,   // optional
    DWORD PropertyInformationLength,
    DWORD Reserved1,   // optional
    DWORD* ReturnLength,   // optional
    void* Reserved2   // optional
);

パラメーター

名前

型

方向

説明

RequestQueueHandle

HANDLE

プロパティを問い合わせる対象要求キューのハンドル。

Property

HTTP_SERVER_PROPERTY

設定されるプロパティの種類を示す HTTP_SERVER_PROPERTY 列挙体のメンバー。次のいずれかを指定できます。

プロパティ	意味
HttpServer503VerbosityProperty	リクエストキューに対して生成される 503 応答の現在の詳細レベルを照会します。
HttpServerQueueLengthProperty	リクエストキュー内で未処理のリクエスト数の上限を照会します。
HttpServerStateProperty	リクエストキューの現在の状態を照会します。状態は active または inactive のいずれかでなければなりません。

PropertyInformation

void*

outoptional

プロパティ情報を受け取るバッファーへのポインター。

pPropertyInformation は、設定されるプロパティに応じて、次のプロパティ情報値のいずれかを指します。

プロパティ	値
HttpServerStateProperty	HTTP_ENABLED_STATE(列挙体のメンバー)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY(列挙体のメンバー)

PropertyInformationLength

DWORD

pPropertyInformation パラメーターが指すバッファーの長さ(バイト単位)。

Reserved1

DWORD

optional

予約済み。ゼロでなければなりません。

ReturnLength

DWORD*

outoptional

NULL でない場合に、pPropertyInformation バッファーに返されるバイト数。

出力バッファーが小さすぎる場合、呼び出しは ERROR_MORE_DATA を返して失敗します。pReturnLength が指す値を使用すると、呼び出しを成功させるために必要なバッファーの最小長を判断できます。

Reserved2

void*

optional

このパラメーターは予約済みであり、NULL でなければなりません。

戻り値の型: DWORD

公式ドキュメント

指定したハンドルで識別されるリクエストキューのプロパティを照会します。

戻り値

関数が成功した場合は NO_ERROR を返します。

関数が失敗した場合は、次のいずれかのエラーコードを返します。

値	意味
ERROR_INVALID_PARAMETER	Reserved パラメーターがゼロでないか、pReserved パラメーターが NULL でありません。 Property パラメーターで指定されたプロパティの種類は、リクエストキューではサポートされていません。 pPropertyInformation パラメーターが NULL です。 PropertyInformationLength パラメーターがゼロです。アプリケーションにリクエストキューを開く権限がありません。
ERROR_MORE_DATA	pPropertyInformation パラメーターが指すバッファーのサイズ(バイト単位)が小さすぎて、プロパティ情報を受け取れません。終了時に pReturnLength が指すサイズ以上のバッファーを指定して、関数を再度呼び出してください。
ERROR_NOT_SUPPORTED	リクエストキューのハンドルが HTTP バージョン 1.0 のハンドルです。プロパティ管理は HTTP バージョン 2.0 以降のリクエストキューでのみサポートされます。

値

意味

ERROR_INVALID_PARAMETER

Reserved パラメーターがゼロでないか、pReserved パラメーターが NULL でありません。

Property パラメーターで指定されたプロパティの種類は、リクエストキューではサポートされていません。

pPropertyInformation パラメーターが NULL です。

PropertyInformationLength パラメーターがゼロです。

アプリケーションにリクエストキューを開く権限がありません。

ERROR_MORE_DATA

pPropertyInformation パラメーターが指すバッファーのサイズ(バイト単位)が小さすぎて、プロパティ情報を受け取れません。終了時に pReturnLength が指すサイズ以上のバッファーを指定して、関数を再度呼び出してください。

ERROR_NOT_SUPPORTED

リクエストキューのハンドルが HTTP バージョン 1.0 のハンドルです。プロパティ管理は HTTP バージョン 2.0 以降のリクエストキューでのみサポートされます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// HTTPAPI.dll
#include <windows.h>

DWORD HttpQueryRequestQueueProperty(
    HANDLE RequestQueueHandle,
    HTTP_SERVER_PROPERTY Property,
    void* PropertyInformation,   // optional
    DWORD PropertyInformationLength,
    DWORD Reserved1,   // optional
    DWORD* ReturnLength,   // optional
    void* Reserved2   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpQueryRequestQueueProperty(
    IntPtr RequestQueueHandle,   // HANDLE
    int Property,   // HTTP_SERVER_PROPERTY
    IntPtr PropertyInformation,   // void* optional, out
    uint PropertyInformationLength,   // DWORD
    uint Reserved1,   // DWORD optional
    IntPtr ReturnLength,   // DWORD* optional, out
    IntPtr Reserved2   // void* optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpQueryRequestQueueProperty(
    RequestQueueHandle As IntPtr,   ' HANDLE
    [Property] As Integer,   ' HTTP_SERVER_PROPERTY
    PropertyInformation As IntPtr,   ' void* optional, out
    PropertyInformationLength As UInteger,   ' DWORD
    Reserved1 As UInteger,   ' DWORD optional
    ReturnLength As IntPtr,   ' DWORD* optional, out
    Reserved2 As IntPtr   ' void* optional
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' Property : HTTP_SERVER_PROPERTY
' PropertyInformation : void* optional, out
' PropertyInformationLength : DWORD
' Reserved1 : DWORD optional
' ReturnLength : DWORD* optional, out
' Reserved2 : void* optional
Declare PtrSafe Function HttpQueryRequestQueueProperty Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal Property As Long, _
    ByVal PropertyInformation As LongPtr, _
    ByVal PropertyInformationLength As Long, _
    ByVal Reserved1 As Long, _
    ByVal ReturnLength As LongPtr, _
    ByVal Reserved2 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpQueryRequestQueueProperty = ctypes.windll.httpapi.HttpQueryRequestQueueProperty
HttpQueryRequestQueueProperty.restype = wintypes.DWORD
HttpQueryRequestQueueProperty.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_int,  # Property : HTTP_SERVER_PROPERTY
    ctypes.POINTER(None),  # PropertyInformation : void* optional, out
    wintypes.DWORD,  # PropertyInformationLength : DWORD
    wintypes.DWORD,  # Reserved1 : DWORD optional
    ctypes.POINTER(wintypes.DWORD),  # ReturnLength : DWORD* optional, out
    ctypes.POINTER(None),  # Reserved2 : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpQueryRequestQueueProperty = Fiddle::Function.new(
  lib['HttpQueryRequestQueueProperty'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    Fiddle::TYPE_INT,  # Property : HTTP_SERVER_PROPERTY
    Fiddle::TYPE_VOIDP,  # PropertyInformation : void* optional, out
    -Fiddle::TYPE_INT,  # PropertyInformationLength : DWORD
    -Fiddle::TYPE_INT,  # Reserved1 : DWORD optional
    Fiddle::TYPE_VOIDP,  # ReturnLength : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Reserved2 : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpQueryRequestQueueProperty(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        Property: i32,  // HTTP_SERVER_PROPERTY
        PropertyInformation: *mut (),  // void* optional, out
        PropertyInformationLength: u32,  // DWORD
        Reserved1: u32,  // DWORD optional
        ReturnLength: *mut u32,  // DWORD* optional, out
        Reserved2: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpQueryRequestQueueProperty(IntPtr RequestQueueHandle, int Property, IntPtr PropertyInformation, uint PropertyInformationLength, uint Reserved1, IntPtr ReturnLength, IntPtr Reserved2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpQueryRequestQueueProperty' -Namespace Win32 -PassThru
# $api::HttpQueryRequestQueueProperty(RequestQueueHandle, Property, PropertyInformation, PropertyInformationLength, Reserved1, ReturnLength, Reserved2)

#uselib "HTTPAPI.dll"
#func global HttpQueryRequestQueueProperty "HttpQueryRequestQueueProperty" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpQueryRequestQueueProperty RequestQueueHandle, Property, PropertyInformation, PropertyInformationLength, Reserved1, varptr(ReturnLength), Reserved2   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; Property : HTTP_SERVER_PROPERTY -> "sptr"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "sptr"
; Reserved1 : DWORD optional -> "sptr"
; ReturnLength : DWORD* optional, out -> "sptr"
; Reserved2 : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestQueueProperty "HttpQueryRequestQueueProperty" sptr, int, sptr, int, int, var, sptr
; res = HttpQueryRequestQueueProperty(RequestQueueHandle, Property, PropertyInformation, PropertyInformationLength, Reserved1, ReturnLength, Reserved2)
; RequestQueueHandle : HANDLE -> "sptr"
; Property : HTTP_SERVER_PROPERTY -> "int"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "int"
; Reserved1 : DWORD optional -> "int"
; ReturnLength : DWORD* optional, out -> "var"
; Reserved2 : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HTTPAPI.dll"
#cfunc global HttpQueryRequestQueueProperty "HttpQueryRequestQueueProperty" sptr, int, sptr, int, int, sptr, sptr
; res = HttpQueryRequestQueueProperty(RequestQueueHandle, Property, PropertyInformation, PropertyInformationLength, Reserved1, varptr(ReturnLength), Reserved2)
; RequestQueueHandle : HANDLE -> "sptr"
; Property : HTTP_SERVER_PROPERTY -> "int"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "int"
; Reserved1 : DWORD optional -> "int"
; ReturnLength : DWORD* optional, out -> "sptr"
; Reserved2 : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。