Win32 API 日本語リファレンス
ホームNetworking.HttpServer › HttpCloseRequestQueue

HttpCloseRequestQueue

関数
HTTPリクエストキューのハンドルを閉じる。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle
);

パラメーター

名前方向説明
RequestQueueHandleHTTP_REQUEST_QUEUE_HANDLEin閉じるリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

戻り値の型: DWORD

公式ドキュメント

HttpCreateRequestQueue によって作成された、指定したリクエストキューへのハンドルを閉じます。

戻り値

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

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

意味
ERROR_INVALID_PARAMETER
アプリケーションにリクエストキューを閉じる権限がありません。リクエストキューを閉じることができるのは、それを作成したアプリケーションのみです。

解説(Remarks)

アプリケーションは、リクエストキューのハンドルに対して CloseHandle を呼び出すべきではありません。代わりに HttpCloseRequestQueue を呼び出して、すべてのリソースが解放されるようにしてください。

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

各言語での呼び出し定義

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

DWORD HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle
);
[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle   // HTTP_REQUEST_QUEUE_HANDLE
);
<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpCloseRequestQueue(
    RequestQueueHandle As HTTP_REQUEST_QUEUE_HANDLE   ' HTTP_REQUEST_QUEUE_HANDLE
) As UInteger
End Function
' RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE
Declare PtrSafe Function HttpCloseRequestQueue Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpCloseRequestQueue = ctypes.windll.httpapi.HttpCloseRequestQueue
HttpCloseRequestQueue.restype = wintypes.DWORD
HttpCloseRequestQueue.argtypes = [
    HTTP_REQUEST_QUEUE_HANDLE,  # RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpCloseRequestQueue = Fiddle::Function.new(
  lib['HttpCloseRequestQueue'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "httpapi")]
extern "system" {
    fn HttpCloseRequestQueue(
        RequestQueueHandle: HTTP_REQUEST_QUEUE_HANDLE  // HTTP_REQUEST_QUEUE_HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpCloseRequestQueue(HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpCloseRequestQueue' -Namespace Win32 -PassThru
# $api::HttpCloseRequestQueue(RequestQueueHandle)
#uselib "HTTPAPI.dll"
#func global HttpCloseRequestQueue "HttpCloseRequestQueue" sptr
; HttpCloseRequestQueue RequestQueueHandle   ; 戻り値は stat
; RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "HTTPAPI.dll"
#cfunc global HttpCloseRequestQueue "HttpCloseRequestQueue" int
; res = HttpCloseRequestQueue(RequestQueueHandle)
; RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; DWORD HttpCloseRequestQueue(HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle)
#uselib "HTTPAPI.dll"
#cfunc global HttpCloseRequestQueue "HttpCloseRequestQueue" int
; res = HttpCloseRequestQueue(RequestQueueHandle)
; RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpCloseRequestQueue = httpapi.NewProc("HttpCloseRequestQueue")
)

// RequestQueueHandle (HTTP_REQUEST_QUEUE_HANDLE)
r1, _, err := procHttpCloseRequestQueue.Call(
	uintptr(RequestQueueHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpCloseRequestQueue(
  RequestQueueHandle: HTTP_REQUEST_QUEUE_HANDLE   // HTTP_REQUEST_QUEUE_HANDLE
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpCloseRequestQueue';
result := DllCall("HTTPAPI\HttpCloseRequestQueue"
    , "Ptr", RequestQueueHandle   ; HTTP_REQUEST_QUEUE_HANDLE
    , "UInt")   ; return: DWORD
●HttpCloseRequestQueue(RequestQueueHandle) = DLL("HTTPAPI.dll", "dword HttpCloseRequestQueue(void*)")
# 呼び出し: HttpCloseRequestQueue(RequestQueueHandle)
# RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "httpapi" fn HttpCloseRequestQueue(
    RequestQueueHandle: HTTP_REQUEST_QUEUE_HANDLE // HTTP_REQUEST_QUEUE_HANDLE
) callconv(std.os.windows.WINAPI) u32;
proc HttpCloseRequestQueue(
    RequestQueueHandle: HTTP_REQUEST_QUEUE_HANDLE  # HTTP_REQUEST_QUEUE_HANDLE
): uint32 {.importc: "HttpCloseRequestQueue", stdcall, dynlib: "HTTPAPI.dll".}
pragma(lib, "httpapi");
extern(Windows)
uint HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle   // HTTP_REQUEST_QUEUE_HANDLE
);
ccall((:HttpCloseRequestQueue, "HTTPAPI.dll"), stdcall, UInt32,
      (HTTP_REQUEST_QUEUE_HANDLE,),
      RequestQueueHandle)
# RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> HTTP_REQUEST_QUEUE_HANDLE
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle);
]]
local httpapi = ffi.load("httpapi")
-- httpapi.HttpCloseRequestQueue(RequestQueueHandle)
-- RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('HTTPAPI.dll');
const HttpCloseRequestQueue = lib.func('__stdcall', 'HttpCloseRequestQueue', 'uint32_t', ['HTTP_REQUEST_QUEUE_HANDLE']);
// HttpCloseRequestQueue(RequestQueueHandle)
// RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> 'HTTP_REQUEST_QUEUE_HANDLE'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("HTTPAPI.dll", {
  HttpCloseRequestQueue: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.HttpCloseRequestQueue(RequestQueueHandle)
// RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpCloseRequestQueue(
    HTTP_REQUEST_QUEUE_HANDLE RequestQueueHandle);
C, "HTTPAPI.dll");
// $ffi->HttpCloseRequestQueue(RequestQueueHandle);
// RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Httpapi extends StdCallLibrary {
    Httpapi INSTANCE = Native.load("httpapi", Httpapi.class);
    int HttpCloseRequestQueue(
        HTTP_REQUEST_QUEUE_HANDLE /* extends Structure (by value) */ RequestQueueHandle   // HTTP_REQUEST_QUEUE_HANDLE
    );
}
@[Link("httpapi")]
lib LibHTTPAPI
  fun HttpCloseRequestQueue = HttpCloseRequestQueue(
    RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE   # HTTP_REQUEST_QUEUE_HANDLE
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpCloseRequestQueueNative = Uint32 Function(HTTP_REQUEST_QUEUE_HANDLE);
typedef HttpCloseRequestQueueDart = int Function(int);
final HttpCloseRequestQueue = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpCloseRequestQueueNative, HttpCloseRequestQueueDart>('HttpCloseRequestQueue');
// RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> HTTP_REQUEST_QUEUE_HANDLE
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpCloseRequestQueue(
  RequestQueueHandle: HTTP_REQUEST_QUEUE_HANDLE   // HTTP_REQUEST_QUEUE_HANDLE
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpCloseRequestQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpCloseRequestQueue"
  c_HttpCloseRequestQueue :: HTTP_REQUEST_QUEUE_HANDLE -> IO Word32
-- RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> HTTP_REQUEST_QUEUE_HANDLE
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let httpcloserequestqueue =
  foreign "HttpCloseRequestQueue"
    (HTTP_REQUEST_QUEUE_HANDLE @-> returning uint32_t)
(* RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> HTTP_REQUEST_QUEUE_HANDLE *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)

(cffi:defcfun ("HttpCloseRequestQueue" http-close-request-queue :convention :stdcall) :uint32
  (request-queue-handle (:struct http-request-queue-handle)))   ; HTTP_REQUEST_QUEUE_HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpCloseRequestQueue = Win32::API::More->new('HTTPAPI',
    'DWORD HttpCloseRequestQueue(LPVOID RequestQueueHandle)');
# my $ret = $HttpCloseRequestQueue->Call($RequestQueueHandle);
# RequestQueueHandle : HTTP_REQUEST_QUEUE_HANDLE -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型