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

UnlockUrlCacheEntryFile

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

シグネチャ

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

BOOL UnlockUrlCacheEntryFile(
    LPCSTR lpszUrlName,
    DWORD dwReserved   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

アプリケーションは、この関数を呼び出した後にそのファイルへアクセスしてはなりません。

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

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

注意 WinINet はサーバー実装をサポートしていません。さらに、サービスから使用することもできません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 UnlockUrlCacheEntryFile(
    LPCSTR lpszUrlName,
    DWORD dwReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool UnlockUrlCacheEntryFile(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlName,   // LPCSTR
    uint dwReserved   // DWORD optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnlockUrlCacheEntryFile(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrlName As String,   ' LPCSTR
    dwReserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrlName : LPCSTR
' dwReserved : DWORD optional
Declare PtrSafe Function UnlockUrlCacheEntryFile Lib "wininet" ( _
    ByVal lpszUrlName As String, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UnlockUrlCacheEntryFile = ctypes.windll.wininet.UnlockUrlCacheEntryFile
UnlockUrlCacheEntryFile.restype = wintypes.BOOL
UnlockUrlCacheEntryFile.argtypes = [
    wintypes.LPCSTR,  # lpszUrlName : LPCSTR
    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')
UnlockUrlCacheEntryFile = Fiddle::Function.new(
  lib['UnlockUrlCacheEntryFile'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn UnlockUrlCacheEntryFile(
        lpszUrlName: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool UnlockUrlCacheEntryFile([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_UnlockUrlCacheEntryFile' -Namespace Win32 -PassThru
# $api::UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
#uselib "WININET.dll"
#func global UnlockUrlCacheEntryFile "UnlockUrlCacheEntryFile" sptr, sptr
; UnlockUrlCacheEntryFile lpszUrlName, dwReserved   ; 戻り値は stat
; lpszUrlName : LPCSTR -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global UnlockUrlCacheEntryFile "UnlockUrlCacheEntryFile" str, int
; res = UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
; lpszUrlName : LPCSTR -> "str"
; dwReserved : DWORD optional -> "int"
; BOOL UnlockUrlCacheEntryFile(LPCSTR lpszUrlName, DWORD dwReserved)
#uselib "WININET.dll"
#cfunc global UnlockUrlCacheEntryFile "UnlockUrlCacheEntryFile" str, int
; res = UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
; lpszUrlName : LPCSTR -> "str"
; dwReserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procUnlockUrlCacheEntryFile = wininet.NewProc("UnlockUrlCacheEntryFile")
)

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

extern "wininet" fn UnlockUrlCacheEntryFile(
    lpszUrlName: [*c]const u8, // LPCSTR
    dwReserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;
proc UnlockUrlCacheEntryFile(
    lpszUrlName: cstring,  # LPCSTR
    dwReserved: uint32  # DWORD optional
): int32 {.importc: "UnlockUrlCacheEntryFile", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int UnlockUrlCacheEntryFile(
    const(char)* lpszUrlName,   // LPCSTR
    uint dwReserved   // DWORD optional
);
ccall((:UnlockUrlCacheEntryFile, "WININET.dll"), stdcall, Int32,
      (Cstring, UInt32),
      lpszUrlName, dwReserved)
# lpszUrlName : LPCSTR -> Cstring
# dwReserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UnlockUrlCacheEntryFile(
    const char* lpszUrlName,
    uint32_t dwReserved);
]]
local wininet = ffi.load("wininet")
-- wininet.UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
-- lpszUrlName : LPCSTR
-- dwReserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const UnlockUrlCacheEntryFile = lib.func('__stdcall', 'UnlockUrlCacheEntryFile', 'int32_t', ['str', 'uint32_t']);
// UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
// lpszUrlName : LPCSTR -> 'str'
// dwReserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  UnlockUrlCacheEntryFile: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.UnlockUrlCacheEntryFile(lpszUrlName, dwReserved)
// lpszUrlName : LPCSTR -> "buffer"
// dwReserved : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UnlockUrlCacheEntryFile(
    const char* lpszUrlName,
    uint32_t dwReserved);
C, "WININET.dll");
// $ffi->UnlockUrlCacheEntryFile(lpszUrlName, dwReserved);
// lpszUrlName : LPCSTR
// 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.ASCII_OPTIONS);
    boolean UnlockUrlCacheEntryFile(
        String lpszUrlName,   // LPCSTR
        int dwReserved   // DWORD optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun UnlockUrlCacheEntryFile = UnlockUrlCacheEntryFile(
    lpszUrlName : UInt8*,   # LPCSTR
    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 UnlockUrlCacheEntryFileNative = Int32 Function(Pointer<Utf8>, Uint32);
typedef UnlockUrlCacheEntryFileDart = int Function(Pointer<Utf8>, int);
final UnlockUrlCacheEntryFile = DynamicLibrary.open('WININET.dll')
    .lookupFunction<UnlockUrlCacheEntryFileNative, UnlockUrlCacheEntryFileDart>('UnlockUrlCacheEntryFile');
// lpszUrlName : LPCSTR -> Pointer<Utf8>
// dwReserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnlockUrlCacheEntryFile(
  lpszUrlName: PAnsiChar;   // LPCSTR
  dwReserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'WININET.dll' name 'UnlockUrlCacheEntryFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let unlockurlcacheentryfile =
  foreign "UnlockUrlCacheEntryFile"
    (string @-> uint32_t @-> returning int32_t)
(* lpszUrlName : LPCSTR -> string *)
(* 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 ("UnlockUrlCacheEntryFile" unlock-url-cache-entry-file :convention :stdcall) :int32
  (lpsz-url-name :string)   ; LPCSTR
  (dw-reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnlockUrlCacheEntryFile = Win32::API::More->new('WININET',
    'BOOL UnlockUrlCacheEntryFile(LPCSTR lpszUrlName, DWORD dwReserved)');
# my $ret = $UnlockUrlCacheEntryFile->Call($lpszUrlName, $dwReserved);
# lpszUrlName : LPCSTR -> LPCSTR
# dwReserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い