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

UnlockUrlCacheEntryFileW

関数
ロックしたURLキャッシュエントリファイルを解放する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL UnlockUrlCacheEntryFileW(
    LPCWSTR lpszUrlName,
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
lpszUrlNameLPCWSTRinロックを解除するキャッシュエントリのソース名を指定する null 終端文字列へのポインター。この名前文字列にはエスケープ文字を含めないでください。
dwReservedDWORDoptionalこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

UnlockUrlCacheEntryFileW (Unicode) 関数 (wininet.h) は、ファイルをキャッシュから取得して使用する際にロックされたキャッシュエントリのロックを解除します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。ERROR_FILE_NOT_FOUND は、ソース名で指定されたキャッシュエントリがキャッシュストレージ内に見つからないことを示します。

解説(Remarks)

この関数を呼び出した後、アプリケーションはそのファイルにアクセスしないでください。

この関数が戻ると、キャッシュマネージャーはそのキャッシュエントリを自由に削除できるようになります。

WinINet API の他のすべての側面と同様に、この関数を DllMain やグローバルオブジェクトのコンストラクター/デストラクター内から安全に呼び出すことはできません。

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

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UnlockUrlCacheEntryFile を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、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 UnlockUrlCacheEntryFileW(
    LPCWSTR lpszUrlName,
    DWORD dwReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool UnlockUrlCacheEntryFileW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName,   // LPCWSTR
    uint dwReserved   // DWORD optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnlockUrlCacheEntryFileW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrlName As String,   ' LPCWSTR
    dwReserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrlName : LPCWSTR
' dwReserved : DWORD optional
Declare PtrSafe Function UnlockUrlCacheEntryFileW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr, _
    ByVal dwReserved As Long) 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

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

lib = Fiddle.dlopen('WININET.dll')
UnlockUrlCacheEntryFileW = Fiddle::Function.new(
  lib['UnlockUrlCacheEntryFileW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn UnlockUrlCacheEntryFileW(
        lpszUrlName: *const u16,  // LPCWSTR
        dwReserved: u32  // DWORD optional
    ) -> 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 UnlockUrlCacheEntryFileW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_UnlockUrlCacheEntryFileW' -Namespace Win32 -PassThru
# $api::UnlockUrlCacheEntryFileW(lpszUrlName, dwReserved)
#uselib "WININET.dll"
#func global UnlockUrlCacheEntryFileW "UnlockUrlCacheEntryFileW" wptr, wptr
; UnlockUrlCacheEntryFileW lpszUrlName, dwReserved   ; 戻り値は stat
; lpszUrlName : LPCWSTR -> "wptr"
; dwReserved : DWORD optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global UnlockUrlCacheEntryFileW "UnlockUrlCacheEntryFileW" wstr, int
; res = UnlockUrlCacheEntryFileW(lpszUrlName, dwReserved)
; lpszUrlName : LPCWSTR -> "wstr"
; dwReserved : DWORD optional -> "int"
; BOOL UnlockUrlCacheEntryFileW(LPCWSTR lpszUrlName, DWORD dwReserved)
#uselib "WININET.dll"
#cfunc global UnlockUrlCacheEntryFileW "UnlockUrlCacheEntryFileW" wstr, int
; res = UnlockUrlCacheEntryFileW(lpszUrlName, dwReserved)
; lpszUrlName : LPCWSTR -> "wstr"
; dwReserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procUnlockUrlCacheEntryFileW = wininet.NewProc("UnlockUrlCacheEntryFileW")
)

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

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

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

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

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

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

関連項目

文字セット違い