ホーム › Networking.HttpServer › HttpQueryUrlGroupProperty

HttpQueryUrlGroupProperty

関数

URLグループのプロパティを取得する。

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

シグネチャ

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

DWORD HttpQueryUrlGroupProperty(
    ULONGLONG UrlGroupId,
    HTTP_SERVER_PROPERTY Property,
    void* PropertyInformation,   // optional
    DWORD PropertyInformationLength,
    DWORD* ReturnLength   // optional
);

パラメーター

名前

型

方向

説明

UrlGroupId

ULONGLONG

プロパティ設定が返される URL グループの ID。

Property

HTTP_SERVER_PROPERTY

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

プロパティ	意味
HttpServerAuthenticationProperty	有効になっているサーバー側の認証方式を照会します。
HttpServerTimeoutsProperty	URL グループの接続タイムアウト制限を照会します。
HttpServerStateProperty	URL グループの現在の状態を照会します。状態は有効または無効のいずれかです。
HttpServerQosProperty	この値は、QosType が HttpQosSettingTypeBandwidth または HttpQosSettingTypeConnectionLimit のいずれかに設定された汎用的な HTTP_QOS_SETTING_INFO 構造体に対応します。HttpQosSettingTypeBandwidth の場合は URL グループの帯域幅スロットリングを照会します。HttpQosSettingTypeConnectionLimit の場合は、URL グループに対して同時に処理される未処理接続の最大数を照会します。
HttpServerChannelBindProperty	チャネルバインディングトークン (CBT) のプロパティを照会します。

PropertyInformation

void*

outoptional

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

pPropertyInformation は、照会されるプロパティに応じて、次のプロパティ情報構造体のいずれかを指します。

プロパティ	構造体
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

PropertyInformationLength

DWORD

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

ReturnLength

DWORD*

outoptional

pPropertyInformation バッファーに返されるサイズ (バイト単位)。

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

戻り値の型: DWORD

公式ドキュメント

指定された URL グループのプロパティを照会します。

戻り値

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

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

値	意味
ERROR_INVALID_PARAMETER	Property パラメーターで指定されたプロパティの種類が、URL グループではサポートされていません。 UrlGroupId パラメーターが有効なサーバー URL グループを識別していません。 pPropertyInformation パラメーターが NULL です。 PropertyInformationLength パラメーターが 0 です。アプリケーションに URL グループのプロパティを照会する権限がありません。URL グループを作成したアプリケーションのみがそのプロパティを照会できます。
ERROR_MORE_DATA	pPropertyInformation パラメーターが指すバッファーのサイズ (バイト単位) が小さすぎて、プロパティ情報を受け取れません。終了時に pReturnLength が指すサイズ以上のバッファーを指定して、関数を再度呼び出してください。

値

意味

ERROR_INVALID_PARAMETER

Property パラメーターで指定されたプロパティの種類が、URL グループではサポートされていません。

UrlGroupId パラメーターが有効なサーバー URL グループを識別していません。

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

PropertyInformationLength パラメーターが 0 です。

アプリケーションに URL グループのプロパティを照会する権限がありません。URL グループを作成したアプリケーションのみがそのプロパティを照会できます。

ERROR_MORE_DATA

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

解説(Remarks)

HttpServerLoggingProperty の照会はサポートされていません。

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

各言語での呼び出し定義

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

DWORD HttpQueryUrlGroupProperty(
    ULONGLONG UrlGroupId,
    HTTP_SERVER_PROPERTY Property,
    void* PropertyInformation,   // optional
    DWORD PropertyInformationLength,
    DWORD* ReturnLength   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpQueryUrlGroupProperty(
    ulong UrlGroupId,   // ULONGLONG
    int Property,   // HTTP_SERVER_PROPERTY
    IntPtr PropertyInformation,   // void* optional, out
    uint PropertyInformationLength,   // DWORD
    IntPtr ReturnLength   // DWORD* optional, out
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpQueryUrlGroupProperty(
    UrlGroupId As ULong,   ' ULONGLONG
    [Property] As Integer,   ' HTTP_SERVER_PROPERTY
    PropertyInformation As IntPtr,   ' void* optional, out
    PropertyInformationLength As UInteger,   ' DWORD
    ReturnLength As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

HttpQueryUrlGroupProperty = ctypes.windll.httpapi.HttpQueryUrlGroupProperty
HttpQueryUrlGroupProperty.restype = wintypes.DWORD
HttpQueryUrlGroupProperty.argtypes = [
    ctypes.c_ulonglong,  # UrlGroupId : ULONGLONG
    ctypes.c_int,  # Property : HTTP_SERVER_PROPERTY
    ctypes.POINTER(None),  # PropertyInformation : void* optional, out
    wintypes.DWORD,  # PropertyInformationLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ReturnLength : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpQueryUrlGroupProperty = Fiddle::Function.new(
  lib['HttpQueryUrlGroupProperty'],
  [
    -Fiddle::TYPE_LONG_LONG,  # UrlGroupId : ULONGLONG
    Fiddle::TYPE_INT,  # Property : HTTP_SERVER_PROPERTY
    Fiddle::TYPE_VOIDP,  # PropertyInformation : void* optional, out
    -Fiddle::TYPE_INT,  # PropertyInformationLength : DWORD
    Fiddle::TYPE_VOIDP,  # ReturnLength : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpQueryUrlGroupProperty(
        UrlGroupId: u64,  // ULONGLONG
        Property: i32,  // HTTP_SERVER_PROPERTY
        PropertyInformation: *mut (),  // void* optional, out
        PropertyInformationLength: u32,  // DWORD
        ReturnLength: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

#uselib "HTTPAPI.dll"
#func global HttpQueryUrlGroupProperty "HttpQueryUrlGroupProperty" sptr, sptr, sptr, sptr, sptr
; HttpQueryUrlGroupProperty UrlGroupId, Property, PropertyInformation, PropertyInformationLength, varptr(ReturnLength)   ; 戻り値は stat
; UrlGroupId : ULONGLONG -> "sptr"
; Property : HTTP_SERVER_PROPERTY -> "sptr"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "sptr"
; ReturnLength : DWORD* optional, out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpQueryUrlGroupProperty "HttpQueryUrlGroupProperty" int64, int, sptr, int, var
; res = HttpQueryUrlGroupProperty(UrlGroupId, Property, PropertyInformation, PropertyInformationLength, ReturnLength)
; UrlGroupId : ULONGLONG -> "int64"
; Property : HTTP_SERVER_PROPERTY -> "int"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "int"
; ReturnLength : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpQueryUrlGroupProperty "HttpQueryUrlGroupProperty" int64, int, sptr, int, sptr
; res = HttpQueryUrlGroupProperty(UrlGroupId, Property, PropertyInformation, PropertyInformationLength, varptr(ReturnLength))
; UrlGroupId : ULONGLONG -> "int64"
; Property : HTTP_SERVER_PROPERTY -> "int"
; PropertyInformation : void* optional, out -> "sptr"
; PropertyInformationLength : DWORD -> "int"
; ReturnLength : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。