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

HttpRemoveUrl

関数
リクエストキューから登録済みURLを削除する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpRemoveUrl(
    HANDLE RequestQueueHandle,
    LPCWSTR FullyQualifiedUrl
);

パラメーター

名前方向説明
RequestQueueHandleHANDLEin

URL 登録を削除するリクエストキューのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューのハンドルは HttpCreateHttpHandle 関数によって作成されます。

FullyQualifiedUrlLPCWSTRin指定したリクエストキューに登録されている UrlPrefix 文字列 へのポインター。この文字列は、UrlPrefix を登録するために HttpAddUrl に渡したものと完全に一致している必要があります。IPv6 アドレスの表記の変更であっても受け付けられません。

戻り値の型: DWORD

公式ドキュメント

指定した UrlPrefix 文字列に一致するリクエストを、指定したリクエストキューへルーティングするのをシステムに停止させます。

戻り値

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

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

意味
ERROR_ACCESS_DENIED
呼び出し側のアプリケーションに、URL を削除する権限がありません。
ERROR_INVALID_PARAMETER
指定されたパラメーターのうち 1 つ以上が使用できない形式です。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するためのリソースが不足しています。
ERROR_FILE_NOT_FOUND
指定された UrlPrefix が登録データベース内に見つかりませんでした。
その他
WinError.h で定義されている システムエラーコード
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

HttpRemoveUrl = ctypes.windll.httpapi.HttpRemoveUrl
HttpRemoveUrl.restype = wintypes.DWORD
HttpRemoveUrl.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    wintypes.LPCWSTR,  # FullyQualifiedUrl : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpRemoveUrl = Fiddle::Function.new(
  lib['HttpRemoveUrl'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FullyQualifiedUrl : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "httpapi")]
extern "system" {
    fn HttpRemoveUrl(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        FullyQualifiedUrl: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpRemoveUrl(IntPtr RequestQueueHandle, [MarshalAs(UnmanagedType.LPWStr)] string FullyQualifiedUrl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpRemoveUrl' -Namespace Win32 -PassThru
# $api::HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
#uselib "HTTPAPI.dll"
#func global HttpRemoveUrl "HttpRemoveUrl" sptr, sptr
; HttpRemoveUrl RequestQueueHandle, FullyQualifiedUrl   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; FullyQualifiedUrl : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "HTTPAPI.dll"
#cfunc global HttpRemoveUrl "HttpRemoveUrl" sptr, wstr
; res = HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
; RequestQueueHandle : HANDLE -> "sptr"
; FullyQualifiedUrl : LPCWSTR -> "wstr"
; DWORD HttpRemoveUrl(HANDLE RequestQueueHandle, LPCWSTR FullyQualifiedUrl)
#uselib "HTTPAPI.dll"
#cfunc global HttpRemoveUrl "HttpRemoveUrl" intptr, wstr
; res = HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
; RequestQueueHandle : HANDLE -> "intptr"
; FullyQualifiedUrl : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpRemoveUrl = httpapi.NewProc("HttpRemoveUrl")
)

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

extern "httpapi" fn HttpRemoveUrl(
    RequestQueueHandle: ?*anyopaque, // HANDLE
    FullyQualifiedUrl: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
proc HttpRemoveUrl(
    RequestQueueHandle: pointer,  # HANDLE
    FullyQualifiedUrl: WideCString  # LPCWSTR
): uint32 {.importc: "HttpRemoveUrl", stdcall, dynlib: "HTTPAPI.dll".}
pragma(lib, "httpapi");
extern(Windows)
uint HttpRemoveUrl(
    void* RequestQueueHandle,   // HANDLE
    const(wchar)* FullyQualifiedUrl   // LPCWSTR
);
ccall((:HttpRemoveUrl, "HTTPAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring),
      RequestQueueHandle, FullyQualifiedUrl)
# RequestQueueHandle : HANDLE -> Ptr{Cvoid}
# FullyQualifiedUrl : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpRemoveUrl(
    void* RequestQueueHandle,
    const uint16_t* FullyQualifiedUrl);
]]
local httpapi = ffi.load("httpapi")
-- httpapi.HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
-- RequestQueueHandle : HANDLE
-- FullyQualifiedUrl : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('HTTPAPI.dll');
const HttpRemoveUrl = lib.func('__stdcall', 'HttpRemoveUrl', 'uint32_t', ['void *', 'str16']);
// HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
// RequestQueueHandle : HANDLE -> 'void *'
// FullyQualifiedUrl : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("HTTPAPI.dll", {
  HttpRemoveUrl: { parameters: ["pointer", "buffer"], result: "u32" },
});
// lib.symbols.HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl)
// RequestQueueHandle : HANDLE -> "pointer"
// FullyQualifiedUrl : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpRemoveUrl(
    void* RequestQueueHandle,
    const uint16_t* FullyQualifiedUrl);
C, "HTTPAPI.dll");
// $ffi->HttpRemoveUrl(RequestQueueHandle, FullyQualifiedUrl);
// RequestQueueHandle : HANDLE
// FullyQualifiedUrl : LPCWSTR
// 構造体/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 HttpRemoveUrl(
        Pointer RequestQueueHandle,   // HANDLE
        WString FullyQualifiedUrl   // LPCWSTR
    );
}
@[Link("httpapi")]
lib LibHTTPAPI
  fun HttpRemoveUrl = HttpRemoveUrl(
    RequestQueueHandle : Void*,   # HANDLE
    FullyQualifiedUrl : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpRemoveUrlNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>);
typedef HttpRemoveUrlDart = int Function(Pointer<Void>, Pointer<Utf16>);
final HttpRemoveUrl = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpRemoveUrlNative, HttpRemoveUrlDart>('HttpRemoveUrl');
// RequestQueueHandle : HANDLE -> Pointer<Void>
// FullyQualifiedUrl : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpRemoveUrl(
  RequestQueueHandle: THandle;   // HANDLE
  FullyQualifiedUrl: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpRemoveUrl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpRemoveUrl"
  c_HttpRemoveUrl :: Ptr () -> CWString -> IO Word32
-- RequestQueueHandle : HANDLE -> Ptr ()
-- FullyQualifiedUrl : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("HttpRemoveUrl" http-remove-url :convention :stdcall) :uint32
  (request-queue-handle :pointer)   ; HANDLE
  (fully-qualified-url (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpRemoveUrl = Win32::API::More->new('HTTPAPI',
    'DWORD HttpRemoveUrl(HANDLE RequestQueueHandle, LPCWSTR FullyQualifiedUrl)');
# my $ret = $HttpRemoveUrl->Call($RequestQueueHandle, $FullyQualifiedUrl);
# RequestQueueHandle : HANDLE -> HANDLE
# FullyQualifiedUrl : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目