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

DeleteUrlCacheEntryW

関数
指定URLのキャッシュエントリを削除する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL DeleteUrlCacheEntryW(
    LPCWSTR lpszUrlName
);

パラメーター

名前方向説明
lpszUrlNameLPCWSTRinキャッシュエントリに対応するソースの名前を格納した文字列へのポインターです。

戻り値の型: BOOL

公式ドキュメント

DeleteUrlCacheEntryW (Unicode) 関数 (wininet.h) は、ファイルが存在する場合に、指定したソース名に関連付けられたファイルをキャッシュから削除します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返される可能性のあるエラー値には、次のものがあります。

戻り値 説明
ERROR_ACCESS_DENIED
ファイルがロックされているか、使用中です。エントリにはマークが付けられ、ファイルのロックが解除されたときに削除されます。
ERROR_FILE_NOT_FOUND
ファイルがキャッシュ内にありません。

解説(Remarks)

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装またはサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは DeleteUrlCacheEntry をエイリアスとして定義しており、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  (Unicode / -W)
#include <windows.h>

BOOL DeleteUrlCacheEntryW(
    LPCWSTR lpszUrlName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool DeleteUrlCacheEntryW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName   // LPCWSTR
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteUrlCacheEntryW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrlName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrlName : LPCWSTR
Declare PtrSafe Function DeleteUrlCacheEntryW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteUrlCacheEntryW = ctypes.windll.wininet.DeleteUrlCacheEntryW
DeleteUrlCacheEntryW.restype = wintypes.BOOL
DeleteUrlCacheEntryW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrlName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
DeleteUrlCacheEntryW = Fiddle::Function.new(
  lib['DeleteUrlCacheEntryW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn DeleteUrlCacheEntryW(
        lpszUrlName: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool DeleteUrlCacheEntryW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_DeleteUrlCacheEntryW' -Namespace Win32 -PassThru
# $api::DeleteUrlCacheEntryW(lpszUrlName)
#uselib "WININET.dll"
#func global DeleteUrlCacheEntryW "DeleteUrlCacheEntryW" wptr
; DeleteUrlCacheEntryW lpszUrlName   ; 戻り値は stat
; lpszUrlName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global DeleteUrlCacheEntryW "DeleteUrlCacheEntryW" wstr
; res = DeleteUrlCacheEntryW(lpszUrlName)
; lpszUrlName : LPCWSTR -> "wstr"
; BOOL DeleteUrlCacheEntryW(LPCWSTR lpszUrlName)
#uselib "WININET.dll"
#cfunc global DeleteUrlCacheEntryW "DeleteUrlCacheEntryW" wstr
; res = DeleteUrlCacheEntryW(lpszUrlName)
; lpszUrlName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procDeleteUrlCacheEntryW = wininet.NewProc("DeleteUrlCacheEntryW")
)

// lpszUrlName (LPCWSTR)
r1, _, err := procDeleteUrlCacheEntryW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszUrlName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DeleteUrlCacheEntryW(
  lpszUrlName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'DeleteUrlCacheEntryW';
result := DllCall("WININET\DeleteUrlCacheEntryW"
    , "WStr", lpszUrlName   ; LPCWSTR
    , "Int")   ; return: BOOL
●DeleteUrlCacheEntryW(lpszUrlName) = DLL("WININET.dll", "bool DeleteUrlCacheEntryW(char*)")
# 呼び出し: DeleteUrlCacheEntryW(lpszUrlName)
# lpszUrlName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn DeleteUrlCacheEntryW(
    lpszUrlName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DeleteUrlCacheEntryW(
    lpszUrlName: WideCString  # LPCWSTR
): int32 {.importc: "DeleteUrlCacheEntryW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int DeleteUrlCacheEntryW(
    const(wchar)* lpszUrlName   // LPCWSTR
);
ccall((:DeleteUrlCacheEntryW, "WININET.dll"), stdcall, Int32,
      (Cwstring,),
      lpszUrlName)
# lpszUrlName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteUrlCacheEntryW(
    const uint16_t* lpszUrlName);
]]
local wininet = ffi.load("wininet")
-- wininet.DeleteUrlCacheEntryW(lpszUrlName)
-- lpszUrlName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const DeleteUrlCacheEntryW = lib.func('__stdcall', 'DeleteUrlCacheEntryW', 'int32_t', ['str16']);
// DeleteUrlCacheEntryW(lpszUrlName)
// lpszUrlName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  DeleteUrlCacheEntryW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.DeleteUrlCacheEntryW(lpszUrlName)
// lpszUrlName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteUrlCacheEntryW(
    const uint16_t* lpszUrlName);
C, "WININET.dll");
// $ffi->DeleteUrlCacheEntryW(lpszUrlName);
// lpszUrlName : 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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.UNICODE_OPTIONS);
    boolean DeleteUrlCacheEntryW(
        WString lpszUrlName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun DeleteUrlCacheEntryW = DeleteUrlCacheEntryW(
    lpszUrlName : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteUrlCacheEntryWNative = Int32 Function(Pointer<Utf16>);
typedef DeleteUrlCacheEntryWDart = int Function(Pointer<Utf16>);
final DeleteUrlCacheEntryW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<DeleteUrlCacheEntryWNative, DeleteUrlCacheEntryWDart>('DeleteUrlCacheEntryW');
// lpszUrlName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteUrlCacheEntryW(
  lpszUrlName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'DeleteUrlCacheEntryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteUrlCacheEntryW"
  c_DeleteUrlCacheEntryW :: CWString -> IO CInt
-- lpszUrlName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deleteurlcacheentryw =
  foreign "DeleteUrlCacheEntryW"
    ((ptr uint16_t) @-> returning int32_t)
(* lpszUrlName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("DeleteUrlCacheEntryW" delete-url-cache-entry-w :convention :stdcall) :int32
  (lpsz-url-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteUrlCacheEntryW = Win32::API::More->new('WININET',
    'BOOL DeleteUrlCacheEntryW(LPCWSTR lpszUrlName)');
# my $ret = $DeleteUrlCacheEntryW->Call($lpszUrlName);
# lpszUrlName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い