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

CreateUrlCacheEntryExW

関数
拡張オプション付きでURLキャッシュエントリを作成する。
DLLWININET.dll呼出規約winapi

シグネチャ

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

BOOL CreateUrlCacheEntryExW(
    LPCWSTR lpszUrlName,
    DWORD dwExpectedFileSize,
    LPCWSTR lpszFileExtension,   // optional
    LPWSTR lpszFileName,
    DWORD dwReserved,
    BOOL fPreserveIncomingFileName
);

パラメーター

名前方向説明
lpszUrlNameLPCWSTRinキャッシュに登録するリソースのURLを指すワイド文字列。
dwExpectedFileSizeDWORDin格納予定ファイルの想定サイズ(バイト)。不明な場合は0を指定する。
lpszFileExtensionLPCWSTRinoptional生成するローカルファイルの拡張子を指すワイド文字列。NULL可。
lpszFileNameLPWSTRinout生成されたローカルキャッシュファイルのパスを受け取るバッファ(MAX_PATH)。
dwReservedDWORDin将来の拡張用の予約引数。0を指定する。
fPreserveIncomingFileNameBOOLin元のファイル名を保持するかを示すフラグ。TRUEで入力ファイル名を維持する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL CreateUrlCacheEntryExW(
    LPCWSTR lpszUrlName,
    DWORD dwExpectedFileSize,
    LPCWSTR lpszFileExtension,   // optional
    LPWSTR lpszFileName,
    DWORD dwReserved,
    BOOL fPreserveIncomingFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", ExactSpelling = true)]
static extern bool CreateUrlCacheEntryExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName,   // LPCWSTR
    uint dwExpectedFileSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpszFileExtension,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFileName,   // LPWSTR in/out
    uint dwReserved,   // DWORD
    bool fPreserveIncomingFileName   // BOOL
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function CreateUrlCacheEntryExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrlName As String,   ' LPCWSTR
    dwExpectedFileSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszFileExtension As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszFileName As System.Text.StringBuilder,   ' LPWSTR in/out
    dwReserved As UInteger,   ' DWORD
    fPreserveIncomingFileName As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrlName : LPCWSTR
' dwExpectedFileSize : DWORD
' lpszFileExtension : LPCWSTR optional
' lpszFileName : LPWSTR in/out
' dwReserved : DWORD
' fPreserveIncomingFileName : BOOL
Declare PtrSafe Function CreateUrlCacheEntryExW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr, _
    ByVal dwExpectedFileSize As Long, _
    ByVal lpszFileExtension As LongPtr, _
    ByVal lpszFileName As LongPtr, _
    ByVal dwReserved As Long, _
    ByVal fPreserveIncomingFileName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateUrlCacheEntryExW = ctypes.windll.wininet.CreateUrlCacheEntryExW
CreateUrlCacheEntryExW.restype = wintypes.BOOL
CreateUrlCacheEntryExW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrlName : LPCWSTR
    wintypes.DWORD,  # dwExpectedFileSize : DWORD
    wintypes.LPCWSTR,  # lpszFileExtension : LPCWSTR optional
    wintypes.LPWSTR,  # lpszFileName : LPWSTR in/out
    wintypes.DWORD,  # dwReserved : DWORD
    wintypes.BOOL,  # fPreserveIncomingFileName : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
CreateUrlCacheEntryExW = Fiddle::Function.new(
  lib['CreateUrlCacheEntryExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwExpectedFileSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFileExtension : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpszFileName : LPWSTR in/out
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
    Fiddle::TYPE_INT,  # fPreserveIncomingFileName : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn CreateUrlCacheEntryExW(
        lpszUrlName: *const u16,  // LPCWSTR
        dwExpectedFileSize: u32,  // DWORD
        lpszFileExtension: *const u16,  // LPCWSTR optional
        lpszFileName: *mut u16,  // LPWSTR in/out
        dwReserved: u32,  // DWORD
        fPreserveIncomingFileName: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll")]
public static extern bool CreateUrlCacheEntryExW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName, uint dwExpectedFileSize, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileExtension, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFileName, uint dwReserved, bool fPreserveIncomingFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CreateUrlCacheEntryExW' -Namespace Win32 -PassThru
# $api::CreateUrlCacheEntryExW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved, fPreserveIncomingFileName)
#uselib "WININET.dll"
#func global CreateUrlCacheEntryExW "CreateUrlCacheEntryExW" sptr, sptr, sptr, sptr, sptr, sptr
; CreateUrlCacheEntryExW lpszUrlName, dwExpectedFileSize, lpszFileExtension, varptr(lpszFileName), dwReserved, fPreserveIncomingFileName   ; 戻り値は stat
; lpszUrlName : LPCWSTR -> "sptr"
; dwExpectedFileSize : DWORD -> "sptr"
; lpszFileExtension : LPCWSTR optional -> "sptr"
; lpszFileName : LPWSTR in/out -> "sptr"
; dwReserved : DWORD -> "sptr"
; fPreserveIncomingFileName : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global CreateUrlCacheEntryExW "CreateUrlCacheEntryExW" wstr, int, wstr, var, int, int
; res = CreateUrlCacheEntryExW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved, fPreserveIncomingFileName)
; lpszUrlName : LPCWSTR -> "wstr"
; dwExpectedFileSize : DWORD -> "int"
; lpszFileExtension : LPCWSTR optional -> "wstr"
; lpszFileName : LPWSTR in/out -> "var"
; dwReserved : DWORD -> "int"
; fPreserveIncomingFileName : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CreateUrlCacheEntryExW(LPCWSTR lpszUrlName, DWORD dwExpectedFileSize, LPCWSTR lpszFileExtension, LPWSTR lpszFileName, DWORD dwReserved, BOOL fPreserveIncomingFileName)
#uselib "WININET.dll"
#cfunc global CreateUrlCacheEntryExW "CreateUrlCacheEntryExW" wstr, int, wstr, var, int, int
; res = CreateUrlCacheEntryExW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved, fPreserveIncomingFileName)
; lpszUrlName : LPCWSTR -> "wstr"
; dwExpectedFileSize : DWORD -> "int"
; lpszFileExtension : LPCWSTR optional -> "wstr"
; lpszFileName : LPWSTR in/out -> "var"
; dwReserved : DWORD -> "int"
; fPreserveIncomingFileName : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procCreateUrlCacheEntryExW = wininet.NewProc("CreateUrlCacheEntryExW")
)

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

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

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

foreign import stdcall safe "CreateUrlCacheEntryExW"
  c_CreateUrlCacheEntryExW :: CWString -> Word32 -> CWString -> CWString -> Word32 -> CInt -> IO CInt
-- lpszUrlName : LPCWSTR -> CWString
-- dwExpectedFileSize : DWORD -> Word32
-- lpszFileExtension : LPCWSTR optional -> CWString
-- lpszFileName : LPWSTR in/out -> CWString
-- dwReserved : DWORD -> Word32
-- fPreserveIncomingFileName : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("CreateUrlCacheEntryExW" create-url-cache-entry-ex-w :convention :stdcall) :int32
  (lpsz-url-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-expected-file-size :uint32)   ; DWORD
  (lpsz-file-extension (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lpsz-file-name :pointer)   ; LPWSTR in/out
  (dw-reserved :uint32)   ; DWORD
  (f-preserve-incoming-file-name :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateUrlCacheEntryExW = Win32::API::More->new('WININET',
    'BOOL CreateUrlCacheEntryExW(LPCWSTR lpszUrlName, DWORD dwExpectedFileSize, LPCWSTR lpszFileExtension, LPWSTR lpszFileName, DWORD dwReserved, BOOL fPreserveIncomingFileName)');
# my $ret = $CreateUrlCacheEntryExW->Call($lpszUrlName, $dwExpectedFileSize, $lpszFileExtension, $lpszFileName, $dwReserved, $fPreserveIncomingFileName);
# lpszUrlName : LPCWSTR -> LPCWSTR
# dwExpectedFileSize : DWORD -> DWORD
# lpszFileExtension : LPCWSTR optional -> LPCWSTR
# lpszFileName : LPWSTR in/out -> LPWSTR
# dwReserved : DWORD -> DWORD
# fPreserveIncomingFileName : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。