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

DeleteUrlCacheContainerA

関数
URLキャッシュコンテナを削除する。
DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL DeleteUrlCacheContainerA(
    LPCSTR Name,
    DWORD dwOptions
);

パラメーター

名前方向説明
NameLPCSTRin削除するキャッシュ コンテナーの名前。
dwOptionsDWORDinこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

指定された名前に基づいて、キャッシュ コンテナー(キャッシュ エントリを含む)を削除します。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

注意 WinINet はサーバー実装をサポートしていません。さらに、サービスから使用したり、セキュリティ コンテキストを偽装した状態で使用したりしないでください。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

winineti.h ヘッダーは、DeleteUrlCacheContainer を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイル エラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL DeleteUrlCacheContainerA(
    LPCSTR Name,
    DWORD dwOptions
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DeleteUrlCacheContainerA(
    [MarshalAs(UnmanagedType.LPStr)] string Name,   // LPCSTR
    uint dwOptions   // DWORD
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteUrlCacheContainerA(
    <MarshalAs(UnmanagedType.LPStr)> Name As String,   ' LPCSTR
    dwOptions As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Name : LPCSTR
' dwOptions : DWORD
Declare PtrSafe Function DeleteUrlCacheContainerA Lib "wininet" ( _
    ByVal Name As String, _
    ByVal dwOptions As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteUrlCacheContainerA = ctypes.windll.wininet.DeleteUrlCacheContainerA
DeleteUrlCacheContainerA.restype = wintypes.BOOL
DeleteUrlCacheContainerA.argtypes = [
    wintypes.LPCSTR,  # Name : LPCSTR
    wintypes.DWORD,  # dwOptions : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
DeleteUrlCacheContainerA = Fiddle::Function.new(
  lib['DeleteUrlCacheContainerA'],
  [
    Fiddle::TYPE_VOIDP,  # Name : LPCSTR
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn DeleteUrlCacheContainerA(
        Name: *const u8,  // LPCSTR
        dwOptions: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DeleteUrlCacheContainerA([MarshalAs(UnmanagedType.LPStr)] string Name, uint dwOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_DeleteUrlCacheContainerA' -Namespace Win32 -PassThru
# $api::DeleteUrlCacheContainerA(Name, dwOptions)
#uselib "WININET.dll"
#func global DeleteUrlCacheContainerA "DeleteUrlCacheContainerA" sptr, sptr
; DeleteUrlCacheContainerA Name, dwOptions   ; 戻り値は stat
; Name : LPCSTR -> "sptr"
; dwOptions : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global DeleteUrlCacheContainerA "DeleteUrlCacheContainerA" str, int
; res = DeleteUrlCacheContainerA(Name, dwOptions)
; Name : LPCSTR -> "str"
; dwOptions : DWORD -> "int"
; BOOL DeleteUrlCacheContainerA(LPCSTR Name, DWORD dwOptions)
#uselib "WININET.dll"
#cfunc global DeleteUrlCacheContainerA "DeleteUrlCacheContainerA" str, int
; res = DeleteUrlCacheContainerA(Name, dwOptions)
; Name : LPCSTR -> "str"
; dwOptions : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procDeleteUrlCacheContainerA = wininet.NewProc("DeleteUrlCacheContainerA")
)

// Name (LPCSTR), dwOptions (DWORD)
r1, _, err := procDeleteUrlCacheContainerA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(Name))),
	uintptr(dwOptions),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DeleteUrlCacheContainerA(
  Name: PAnsiChar;   // LPCSTR
  dwOptions: DWORD   // DWORD
): BOOL; stdcall;
  external 'WININET.dll' name 'DeleteUrlCacheContainerA';
result := DllCall("WININET\DeleteUrlCacheContainerA"
    , "AStr", Name   ; LPCSTR
    , "UInt", dwOptions   ; DWORD
    , "Int")   ; return: BOOL
●DeleteUrlCacheContainerA(Name, dwOptions) = DLL("WININET.dll", "bool DeleteUrlCacheContainerA(char*, dword)")
# 呼び出し: DeleteUrlCacheContainerA(Name, dwOptions)
# Name : LPCSTR -> "char*"
# dwOptions : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn DeleteUrlCacheContainerA(
    Name: [*c]const u8, // LPCSTR
    dwOptions: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc DeleteUrlCacheContainerA(
    Name: cstring,  # LPCSTR
    dwOptions: uint32  # DWORD
): int32 {.importc: "DeleteUrlCacheContainerA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int DeleteUrlCacheContainerA(
    const(char)* Name,   // LPCSTR
    uint dwOptions   // DWORD
);
ccall((:DeleteUrlCacheContainerA, "WININET.dll"), stdcall, Int32,
      (Cstring, UInt32),
      Name, dwOptions)
# Name : LPCSTR -> Cstring
# dwOptions : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteUrlCacheContainerA(
    const char* Name,
    uint32_t dwOptions);
]]
local wininet = ffi.load("wininet")
-- wininet.DeleteUrlCacheContainerA(Name, dwOptions)
-- Name : LPCSTR
-- dwOptions : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const DeleteUrlCacheContainerA = lib.func('__stdcall', 'DeleteUrlCacheContainerA', 'int32_t', ['str', 'uint32_t']);
// DeleteUrlCacheContainerA(Name, dwOptions)
// Name : LPCSTR -> 'str'
// dwOptions : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  DeleteUrlCacheContainerA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.DeleteUrlCacheContainerA(Name, dwOptions)
// Name : LPCSTR -> "buffer"
// dwOptions : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteUrlCacheContainerA(
    const char* Name,
    uint32_t dwOptions);
C, "WININET.dll");
// $ffi->DeleteUrlCacheContainerA(Name, dwOptions);
// Name : LPCSTR
// dwOptions : 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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.ASCII_OPTIONS);
    boolean DeleteUrlCacheContainerA(
        String Name,   // LPCSTR
        int dwOptions   // DWORD
    );
}
@[Link("wininet")]
lib LibWININET
  fun DeleteUrlCacheContainerA = DeleteUrlCacheContainerA(
    Name : UInt8*,   # LPCSTR
    dwOptions : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteUrlCacheContainerANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef DeleteUrlCacheContainerADart = int Function(Pointer<Utf8>, int);
final DeleteUrlCacheContainerA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<DeleteUrlCacheContainerANative, DeleteUrlCacheContainerADart>('DeleteUrlCacheContainerA');
// Name : LPCSTR -> Pointer<Utf8>
// dwOptions : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteUrlCacheContainerA(
  Name: PAnsiChar;   // LPCSTR
  dwOptions: DWORD   // DWORD
): BOOL; stdcall;
  external 'WININET.dll' name 'DeleteUrlCacheContainerA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteUrlCacheContainerA"
  c_DeleteUrlCacheContainerA :: CString -> Word32 -> IO CInt
-- Name : LPCSTR -> CString
-- dwOptions : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deleteurlcachecontainera =
  foreign "DeleteUrlCacheContainerA"
    (string @-> uint32_t @-> returning int32_t)
(* Name : LPCSTR -> string *)
(* dwOptions : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("DeleteUrlCacheContainerA" delete-url-cache-container-a :convention :stdcall) :int32
  (name :string)   ; LPCSTR
  (dw-options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteUrlCacheContainerA = Win32::API::More->new('WININET',
    'BOOL DeleteUrlCacheContainerA(LPCSTR Name, DWORD dwOptions)');
# my $ret = $DeleteUrlCacheContainerA->Call($Name, $dwOptions);
# Name : LPCSTR -> LPCSTR
# dwOptions : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目