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

HttpRemoveUrlFromUrlGroup

関数
URLグループからURLを削除する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpRemoveUrlFromUrlGroup(
    ULONGLONG UrlGroupId,
    LPCWSTR pFullyQualifiedUrl,
    DWORD Flags
);

パラメーター

名前方向説明
UrlGroupIdULONGLONGinpFullyQualifiedUrl で指定した URL を削除する対象の URL グループの ID。
pFullyQualifiedUrlLPCWSTRin

削除する URL を識別する、正しく構成された UrlPrefix String を含む Unicode 文字列へのポインター。

Flags パラメーターに HTTP_URL_FLAG_REMOVE_ALL を渡した場合、UrlGroupId で識別される URL グループに対する既存の URL 登録がすべてグループから削除されます。この場合、pFullyQualifiedUrlNULL でなければなりません。

FlagsDWORDin

削除する URL を限定する URL フラグ。次のフラグのいずれかを指定できます。

URL フラグ 意味
HTTP_URL_FLAG_REMOVE_ALL
現在 URL グループに登録されているすべての URL を削除します。

戻り値の型: DWORD

公式ドキュメント

指定した URL を、URL グループ ID で識別される URL グループから削除します。

戻り値

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

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

意味
ERROR_INVALID_PARAMETER
URL グループが存在しません。

Flags パラメーターに無効なフラグの組み合わせが含まれています。

HTTP_URL_FLAG_REMOVE_ALL フラグが設定されているにもかかわらず、pFullyQualifiedUrl パラメーターが NULL に設定されていません。

アプリケーションにグループから URL を削除する権限がありません。URL を削除できるのは、その URL グループを作成したアプリケーションのみです。

ERROR_ACCESS_DENIED
呼び出し元のプロセスに、URL の登録を解除する権限がありません。
ERROR_FILE_NOT_FOUND
指定した URL は URL グループに登録されていません。

解説(Remarks)

HTTP Server API はバージョン 1.0 の URL 登録を使用する既存のアプリケーションをサポートしていますが、HTTP Server API を用いた新規開発では HttpRemoveUrlFromUrlGroup を使用してください。HttpRemoveUrl は使用しないでください。

アプリケーションは、URL が不要になった時点で、HttpAddUrlToUrlGroup によってグループに追加した URL を削除する必要があります。

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

各言語での呼び出し定義

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

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

HttpRemoveUrlFromUrlGroup = ctypes.windll.httpapi.HttpRemoveUrlFromUrlGroup
HttpRemoveUrlFromUrlGroup.restype = wintypes.DWORD
HttpRemoveUrlFromUrlGroup.argtypes = [
    ctypes.c_ulonglong,  # UrlGroupId : ULONGLONG
    wintypes.LPCWSTR,  # pFullyQualifiedUrl : LPCWSTR
    wintypes.DWORD,  # Flags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpRemoveUrlFromUrlGroup = Fiddle::Function.new(
  lib['HttpRemoveUrlFromUrlGroup'],
  [
    -Fiddle::TYPE_LONG_LONG,  # UrlGroupId : ULONGLONG
    Fiddle::TYPE_VOIDP,  # pFullyQualifiedUrl : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "httpapi")]
extern "system" {
    fn HttpRemoveUrlFromUrlGroup(
        UrlGroupId: u64,  // ULONGLONG
        pFullyQualifiedUrl: *const u16,  // LPCWSTR
        Flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpRemoveUrlFromUrlGroup(ulong UrlGroupId, [MarshalAs(UnmanagedType.LPWStr)] string pFullyQualifiedUrl, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpRemoveUrlFromUrlGroup' -Namespace Win32 -PassThru
# $api::HttpRemoveUrlFromUrlGroup(UrlGroupId, pFullyQualifiedUrl, Flags)
#uselib "HTTPAPI.dll"
#func global HttpRemoveUrlFromUrlGroup "HttpRemoveUrlFromUrlGroup" sptr, sptr, sptr
; HttpRemoveUrlFromUrlGroup UrlGroupId, pFullyQualifiedUrl, Flags   ; 戻り値は stat
; UrlGroupId : ULONGLONG -> "sptr"
; pFullyQualifiedUrl : LPCWSTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "HTTPAPI.dll"
#cfunc global HttpRemoveUrlFromUrlGroup "HttpRemoveUrlFromUrlGroup" int64, wstr, int
; res = HttpRemoveUrlFromUrlGroup(UrlGroupId, pFullyQualifiedUrl, Flags)
; UrlGroupId : ULONGLONG -> "int64"
; pFullyQualifiedUrl : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; DWORD HttpRemoveUrlFromUrlGroup(ULONGLONG UrlGroupId, LPCWSTR pFullyQualifiedUrl, DWORD Flags)
#uselib "HTTPAPI.dll"
#cfunc global HttpRemoveUrlFromUrlGroup "HttpRemoveUrlFromUrlGroup" int64, wstr, int
; res = HttpRemoveUrlFromUrlGroup(UrlGroupId, pFullyQualifiedUrl, Flags)
; UrlGroupId : ULONGLONG -> "int64"
; pFullyQualifiedUrl : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpRemoveUrlFromUrlGroup = httpapi.NewProc("HttpRemoveUrlFromUrlGroup")
)

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

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

typedef HttpRemoveUrlFromUrlGroupNative = Uint32 Function(Uint64, Pointer<Utf16>, Uint32);
typedef HttpRemoveUrlFromUrlGroupDart = int Function(int, Pointer<Utf16>, int);
final HttpRemoveUrlFromUrlGroup = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpRemoveUrlFromUrlGroupNative, HttpRemoveUrlFromUrlGroupDart>('HttpRemoveUrlFromUrlGroup');
// UrlGroupId : ULONGLONG -> Uint64
// pFullyQualifiedUrl : LPCWSTR -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpRemoveUrlFromUrlGroup(
  UrlGroupId: UInt64;   // ULONGLONG
  pFullyQualifiedUrl: PWideChar;   // LPCWSTR
  Flags: DWORD   // DWORD
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpRemoveUrlFromUrlGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpRemoveUrlFromUrlGroup"
  c_HttpRemoveUrlFromUrlGroup :: Word64 -> CWString -> Word32 -> IO Word32
-- UrlGroupId : ULONGLONG -> Word64
-- pFullyQualifiedUrl : LPCWSTR -> CWString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpremoveurlfromurlgroup =
  foreign "HttpRemoveUrlFromUrlGroup"
    (uint64_t @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* UrlGroupId : ULONGLONG -> uint64_t *)
(* pFullyQualifiedUrl : LPCWSTR -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)

(cffi:defcfun ("HttpRemoveUrlFromUrlGroup" http-remove-url-from-url-group :convention :stdcall) :uint32
  (url-group-id :uint64)   ; ULONGLONG
  (p-fully-qualified-url (:string :encoding :utf-16le))   ; LPCWSTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpRemoveUrlFromUrlGroup = Win32::API::More->new('HTTPAPI',
    'DWORD HttpRemoveUrlFromUrlGroup(UINT64 UrlGroupId, LPCWSTR pFullyQualifiedUrl, DWORD Flags)');
# my $ret = $HttpRemoveUrlFromUrlGroup->Call($UrlGroupId, $pFullyQualifiedUrl, $Flags);
# UrlGroupId : ULONGLONG -> UINT64
# pFullyQualifiedUrl : LPCWSTR -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目