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

InternetLockRequestFile

関数
ダウンロード中のキャッシュファイルをロックして削除を防ぐ。
DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetLockRequestFile(
    void* hInternet,
    HANDLE* lphLockRequestInfo
);

パラメーター

名前方向説明
hInternetvoid*inFtpOpenFileGopherOpenFileHttpOpenRequest、または InternetOpenUrl 関数が返したハンドル。
lphLockRequestInfoHANDLE*outロック要求ハンドルを受け取るハンドルへのポインター。

戻り値の型: BOOL

公式ドキュメント

使用中のファイルにロックを設定します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。特定のエラーメッセージを取得するには、 GetLastError を呼び出してください。

解説(Remarks)

hInternet に渡された HINTERNET ハンドルが INTERNET_FLAG_NO_CACHE_WRITE または INTERNET_FLAG_DONT_CACHE を使用して作成された場合、HTTPS リソースでない限り、この関数は拡張子 .tmp の一時ファイルを作成します。ハンドルが INTERNET_FLAG_NO_CACHE_WRITE または INTERNET_FLAG_DONT_CACHE を使用して作成され、かつ HTTPS リソースにアクセスしている場合、 InternetLockRequestFile は失敗します。

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
#include <windows.h>

BOOL InternetLockRequestFile(
    void* hInternet,
    HANDLE* lphLockRequestInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InternetLockRequestFile(
    IntPtr hInternet,   // void*
    IntPtr lphLockRequestInfo   // HANDLE* out
);
<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetLockRequestFile(
    hInternet As IntPtr,   ' void*
    lphLockRequestInfo As IntPtr   ' HANDLE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hInternet : void*
' lphLockRequestInfo : HANDLE* out
Declare PtrSafe Function InternetLockRequestFile Lib "wininet" ( _
    ByVal hInternet As LongPtr, _
    ByVal lphLockRequestInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetLockRequestFile = ctypes.windll.wininet.InternetLockRequestFile
InternetLockRequestFile.restype = wintypes.BOOL
InternetLockRequestFile.argtypes = [
    ctypes.POINTER(None),  # hInternet : void*
    ctypes.c_void_p,  # lphLockRequestInfo : HANDLE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetLockRequestFile = Fiddle::Function.new(
  lib['InternetLockRequestFile'],
  [
    Fiddle::TYPE_VOIDP,  # hInternet : void*
    Fiddle::TYPE_VOIDP,  # lphLockRequestInfo : HANDLE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn InternetLockRequestFile(
        hInternet: *mut (),  // void*
        lphLockRequestInfo: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true)]
public static extern bool InternetLockRequestFile(IntPtr hInternet, IntPtr lphLockRequestInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetLockRequestFile' -Namespace Win32 -PassThru
# $api::InternetLockRequestFile(hInternet, lphLockRequestInfo)
#uselib "WININET.dll"
#func global InternetLockRequestFile "InternetLockRequestFile" sptr, sptr
; InternetLockRequestFile hInternet, lphLockRequestInfo   ; 戻り値は stat
; hInternet : void* -> "sptr"
; lphLockRequestInfo : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetLockRequestFile "InternetLockRequestFile" sptr, sptr
; res = InternetLockRequestFile(hInternet, lphLockRequestInfo)
; hInternet : void* -> "sptr"
; lphLockRequestInfo : HANDLE* out -> "sptr"
; BOOL InternetLockRequestFile(void* hInternet, HANDLE* lphLockRequestInfo)
#uselib "WININET.dll"
#cfunc global InternetLockRequestFile "InternetLockRequestFile" intptr, intptr
; res = InternetLockRequestFile(hInternet, lphLockRequestInfo)
; hInternet : void* -> "intptr"
; lphLockRequestInfo : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetLockRequestFile = wininet.NewProc("InternetLockRequestFile")
)

// hInternet (void*), lphLockRequestInfo (HANDLE* out)
r1, _, err := procInternetLockRequestFile.Call(
	uintptr(hInternet),
	uintptr(lphLockRequestInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetLockRequestFile(
  hInternet: Pointer;   // void*
  lphLockRequestInfo: Pointer   // HANDLE* out
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetLockRequestFile';
result := DllCall("WININET\InternetLockRequestFile"
    , "Ptr", hInternet   ; void*
    , "Ptr", lphLockRequestInfo   ; HANDLE* out
    , "Int")   ; return: BOOL
●InternetLockRequestFile(hInternet, lphLockRequestInfo) = DLL("WININET.dll", "bool InternetLockRequestFile(void*, void*)")
# 呼び出し: InternetLockRequestFile(hInternet, lphLockRequestInfo)
# hInternet : void* -> "void*"
# lphLockRequestInfo : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn InternetLockRequestFile(
    hInternet: ?*anyopaque, // void*
    lphLockRequestInfo: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) i32;
proc InternetLockRequestFile(
    hInternet: pointer,  # void*
    lphLockRequestInfo: pointer  # HANDLE* out
): int32 {.importc: "InternetLockRequestFile", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int InternetLockRequestFile(
    void* hInternet,   // void*
    void* lphLockRequestInfo   // HANDLE* out
);
ccall((:InternetLockRequestFile, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      hInternet, lphLockRequestInfo)
# hInternet : void* -> Ptr{Cvoid}
# lphLockRequestInfo : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternetLockRequestFile(
    void* hInternet,
    void* lphLockRequestInfo);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetLockRequestFile(hInternet, lphLockRequestInfo)
-- hInternet : void*
-- lphLockRequestInfo : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetLockRequestFile = lib.func('__stdcall', 'InternetLockRequestFile', 'int32_t', ['void *', 'void *']);
// InternetLockRequestFile(hInternet, lphLockRequestInfo)
// hInternet : void* -> 'void *'
// lphLockRequestInfo : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetLockRequestFile: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.InternetLockRequestFile(hInternet, lphLockRequestInfo)
// hInternet : void* -> "pointer"
// lphLockRequestInfo : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternetLockRequestFile(
    void* hInternet,
    void* lphLockRequestInfo);
C, "WININET.dll");
// $ffi->InternetLockRequestFile(hInternet, lphLockRequestInfo);
// hInternet : void*
// lphLockRequestInfo : HANDLE* out
// 構造体/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);
    boolean InternetLockRequestFile(
        Pointer hInternet,   // void*
        Pointer lphLockRequestInfo   // HANDLE* out
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetLockRequestFile = InternetLockRequestFile(
    hInternet : Void*,   # void*
    lphLockRequestInfo : Void*   # HANDLE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetLockRequestFileNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef InternetLockRequestFileDart = int Function(Pointer<Void>, Pointer<Void>);
final InternetLockRequestFile = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetLockRequestFileNative, InternetLockRequestFileDart>('InternetLockRequestFile');
// hInternet : void* -> Pointer<Void>
// lphLockRequestInfo : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetLockRequestFile(
  hInternet: Pointer;   // void*
  lphLockRequestInfo: Pointer   // HANDLE* out
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetLockRequestFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetLockRequestFile"
  c_InternetLockRequestFile :: Ptr () -> Ptr () -> IO CInt
-- hInternet : void* -> Ptr ()
-- lphLockRequestInfo : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetlockrequestfile =
  foreign "InternetLockRequestFile"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hInternet : void* -> (ptr void) *)
(* lphLockRequestInfo : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetLockRequestFile" internet-lock-request-file :convention :stdcall) :int32
  (h-internet :pointer)   ; void*
  (lph-lock-request-info :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetLockRequestFile = Win32::API::More->new('WININET',
    'BOOL InternetLockRequestFile(LPVOID hInternet, HANDLE lphLockRequestInfo)');
# my $ret = $InternetLockRequestFile->Call($hInternet, $lphLockRequestInfo);
# hInternet : void* -> LPVOID
# lphLockRequestInfo : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目