Win32 API 日本語リファレンス
ホーム › System.Com.Urlmon › URLDownloadToCacheFileA

URLDownloadToCacheFileA

関数
指定URLの内容をキャッシュファイルへダウンロードしそのパスを返す(ANSI版)。
DLLurlmon.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

HRESULT URLDownloadToCacheFileA(
    IUnknown* param0,   // optional
    LPCSTR param1,
    LPSTR param2,
    DWORD cchFileName,
    DWORD param4,
    IBindStatusCallback* param5   // optional
);

パラメーター

名前型方向説明
param0IUnknown*inoptional呼び出し元コントロールのIUnknownへのポインタ。NULL可。
param1LPCSTRinダウンロード元のURL文字列(ANSI)。
param2LPSTRoutキャッシュファイルパスを受け取る出力バッファ(ANSI)。
cchFileNameDWORDinparam2バッファのサイズ(文字数単位)。
param4DWORDin予約パラメータ。0を指定する。
param5IBindStatusCallback*inoptionalダウンロード進捗通知を受け取るIBindStatusCallbackへのポインタ。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT URLDownloadToCacheFileA(
    IUnknown* param0,   // optional
    LPCSTR param1,
    LPSTR param2,
    DWORD cchFileName,
    DWORD param4,
    IBindStatusCallback* param5   // optional
);
[DllImport("urlmon.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int URLDownloadToCacheFileA(
    IntPtr param0,   // IUnknown* optional
    [MarshalAs(UnmanagedType.LPStr)] string param1,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder param2,   // LPSTR out
    uint cchFileName,   // DWORD
    uint param4,   // DWORD
    IntPtr param5   // IBindStatusCallback* optional
);
<DllImport("urlmon.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function URLDownloadToCacheFileA(
    param0 As IntPtr,   ' IUnknown* optional
    <MarshalAs(UnmanagedType.LPStr)> param1 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> param2 As System.Text.StringBuilder,   ' LPSTR out
    cchFileName As UInteger,   ' DWORD
    param4 As UInteger,   ' DWORD
    param5 As IntPtr   ' IBindStatusCallback* optional
) As Integer
End Function
' param0 : IUnknown* optional
' param1 : LPCSTR
' param2 : LPSTR out
' cchFileName : DWORD
' param4 : DWORD
' param5 : IBindStatusCallback* optional
Declare PtrSafe Function URLDownloadToCacheFileA Lib "urlmon" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As String, _
    ByVal param2 As String, _
    ByVal cchFileName As Long, _
    ByVal param4 As Long, _
    ByVal param5 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

URLDownloadToCacheFileA = ctypes.windll.urlmon.URLDownloadToCacheFileA
URLDownloadToCacheFileA.restype = ctypes.c_int
URLDownloadToCacheFileA.argtypes = [
    ctypes.c_void_p,  # param0 : IUnknown* optional
    wintypes.LPCSTR,  # param1 : LPCSTR
    wintypes.LPSTR,  # param2 : LPSTR out
    wintypes.DWORD,  # cchFileName : DWORD
    wintypes.DWORD,  # param4 : DWORD
    ctypes.c_void_p,  # param5 : IBindStatusCallback* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('urlmon.dll')
URLDownloadToCacheFileA = Fiddle::Function.new(
  lib['URLDownloadToCacheFileA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : IUnknown* optional
    Fiddle::TYPE_VOIDP,  # param1 : LPCSTR
    Fiddle::TYPE_VOIDP,  # param2 : LPSTR out
    -Fiddle::TYPE_INT,  # cchFileName : DWORD
    -Fiddle::TYPE_INT,  # param4 : DWORD
    Fiddle::TYPE_VOIDP,  # param5 : IBindStatusCallback* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "urlmon")]
extern "system" {
    fn URLDownloadToCacheFileA(
        param0: *mut core::ffi::c_void,  // IUnknown* optional
        param1: *const u8,  // LPCSTR
        param2: *mut u8,  // LPSTR out
        cchFileName: u32,  // DWORD
        param4: u32,  // DWORD
        param5: *mut core::ffi::c_void  // IBindStatusCallback* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("urlmon.dll", CharSet = CharSet.Ansi)]
public static extern int URLDownloadToCacheFileA(IntPtr param0, [MarshalAs(UnmanagedType.LPStr)] string param1, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder param2, uint cchFileName, uint param4, IntPtr param5);
"@
$api = Add-Type -MemberDefinition $sig -Name 'urlmon_URLDownloadToCacheFileA' -Namespace Win32 -PassThru
# $api::URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
#uselib "urlmon.dll"
#func global URLDownloadToCacheFileA "URLDownloadToCacheFileA" sptr, sptr, sptr, sptr, sptr, sptr
; URLDownloadToCacheFileA param0, param1, varptr(param2), cchFileName, param4, param5   ; 戻り値は stat
; param0 : IUnknown* optional -> "sptr"
; param1 : LPCSTR -> "sptr"
; param2 : LPSTR out -> "sptr"
; cchFileName : DWORD -> "sptr"
; param4 : DWORD -> "sptr"
; param5 : IBindStatusCallback* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "urlmon.dll"
#cfunc global URLDownloadToCacheFileA "URLDownloadToCacheFileA" sptr, str, var, int, int, sptr
; res = URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
; param0 : IUnknown* optional -> "sptr"
; param1 : LPCSTR -> "str"
; param2 : LPSTR out -> "var"
; cchFileName : DWORD -> "int"
; param4 : DWORD -> "int"
; param5 : IBindStatusCallback* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT URLDownloadToCacheFileA(IUnknown* param0, LPCSTR param1, LPSTR param2, DWORD cchFileName, DWORD param4, IBindStatusCallback* param5)
#uselib "urlmon.dll"
#cfunc global URLDownloadToCacheFileA "URLDownloadToCacheFileA" intptr, str, var, int, int, intptr
; res = URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
; param0 : IUnknown* optional -> "intptr"
; param1 : LPCSTR -> "str"
; param2 : LPSTR out -> "var"
; cchFileName : DWORD -> "int"
; param4 : DWORD -> "int"
; param5 : IBindStatusCallback* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	urlmon = windows.NewLazySystemDLL("urlmon.dll")
	procURLDownloadToCacheFileA = urlmon.NewProc("URLDownloadToCacheFileA")
)

// param0 (IUnknown* optional), param1 (LPCSTR), param2 (LPSTR out), cchFileName (DWORD), param4 (DWORD), param5 (IBindStatusCallback* optional)
r1, _, err := procURLDownloadToCacheFileA.Call(
	uintptr(param0),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(param1))),
	uintptr(param2),
	uintptr(cchFileName),
	uintptr(param4),
	uintptr(param5),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function URLDownloadToCacheFileA(
  param0: Pointer;   // IUnknown* optional
  param1: PAnsiChar;   // LPCSTR
  param2: PAnsiChar;   // LPSTR out
  cchFileName: DWORD;   // DWORD
  param4: DWORD;   // DWORD
  param5: Pointer   // IBindStatusCallback* optional
): Integer; stdcall;
  external 'urlmon.dll' name 'URLDownloadToCacheFileA';
result := DllCall("urlmon\URLDownloadToCacheFileA"
    , "Ptr", param0   ; IUnknown* optional
    , "AStr", param1   ; LPCSTR
    , "Ptr", param2   ; LPSTR out
    , "UInt", cchFileName   ; DWORD
    , "UInt", param4   ; DWORD
    , "Ptr", param5   ; IBindStatusCallback* optional
    , "Int")   ; return: HRESULT
●URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5) = DLL("urlmon.dll", "int URLDownloadToCacheFileA(void*, char*, char*, dword, dword, void*)")
# 呼び出し: URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
# param0 : IUnknown* optional -> "void*"
# param1 : LPCSTR -> "char*"
# param2 : LPSTR out -> "char*"
# cchFileName : DWORD -> "dword"
# param4 : DWORD -> "dword"
# param5 : IBindStatusCallback* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "urlmon" fn URLDownloadToCacheFileA(
    param0: ?*anyopaque, // IUnknown* optional
    param1: [*c]const u8, // LPCSTR
    param2: [*c]u8, // LPSTR out
    cchFileName: u32, // DWORD
    param4: u32, // DWORD
    param5: ?*anyopaque // IBindStatusCallback* optional
) callconv(std.os.windows.WINAPI) i32;
proc URLDownloadToCacheFileA(
    param0: pointer,  # IUnknown* optional
    param1: cstring,  # LPCSTR
    param2: ptr char,  # LPSTR out
    cchFileName: uint32,  # DWORD
    param4: uint32,  # DWORD
    param5: pointer  # IBindStatusCallback* optional
): int32 {.importc: "URLDownloadToCacheFileA", stdcall, dynlib: "urlmon.dll".}
pragma(lib, "urlmon");
extern(Windows)
int URLDownloadToCacheFileA(
    void* param0,   // IUnknown* optional
    const(char)* param1,   // LPCSTR
    char* param2,   // LPSTR out
    uint cchFileName,   // DWORD
    uint param4,   // DWORD
    void* param5   // IBindStatusCallback* optional
);
ccall((:URLDownloadToCacheFileA, "urlmon.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Ptr{UInt8}, UInt32, UInt32, Ptr{Cvoid}),
      param0, param1, param2, cchFileName, param4, param5)
# param0 : IUnknown* optional -> Ptr{Cvoid}
# param1 : LPCSTR -> Cstring
# param2 : LPSTR out -> Ptr{UInt8}
# cchFileName : DWORD -> UInt32
# param4 : DWORD -> UInt32
# param5 : IBindStatusCallback* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t URLDownloadToCacheFileA(
    void* param0,
    const char* param1,
    char* param2,
    uint32_t cchFileName,
    uint32_t param4,
    void* param5);
]]
local urlmon = ffi.load("urlmon")
-- urlmon.URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
-- param0 : IUnknown* optional
-- param1 : LPCSTR
-- param2 : LPSTR out
-- cchFileName : DWORD
-- param4 : DWORD
-- param5 : IBindStatusCallback* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('urlmon.dll');
const URLDownloadToCacheFileA = lib.func('__stdcall', 'URLDownloadToCacheFileA', 'int32_t', ['void *', 'str', 'char *', 'uint32_t', 'uint32_t', 'void *']);
// URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
// param0 : IUnknown* optional -> 'void *'
// param1 : LPCSTR -> 'str'
// param2 : LPSTR out -> 'char *'
// cchFileName : DWORD -> 'uint32_t'
// param4 : DWORD -> 'uint32_t'
// param5 : IBindStatusCallback* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("urlmon.dll", {
  URLDownloadToCacheFileA: { parameters: ["pointer", "buffer", "buffer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5)
// param0 : IUnknown* optional -> "pointer"
// param1 : LPCSTR -> "buffer"
// param2 : LPSTR out -> "buffer"
// cchFileName : DWORD -> "u32"
// param4 : DWORD -> "u32"
// param5 : IBindStatusCallback* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t URLDownloadToCacheFileA(
    void* param0,
    const char* param1,
    char* param2,
    uint32_t cchFileName,
    uint32_t param4,
    void* param5);
C, "urlmon.dll");
// $ffi->URLDownloadToCacheFileA(param0, param1, param2, cchFileName, param4, param5);
// param0 : IUnknown* optional
// param1 : LPCSTR
// param2 : LPSTR out
// cchFileName : DWORD
// param4 : DWORD
// param5 : IBindStatusCallback* 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 Urlmon extends StdCallLibrary {
    Urlmon INSTANCE = Native.load("urlmon", Urlmon.class, W32APIOptions.ASCII_OPTIONS);
    int URLDownloadToCacheFileA(
        Pointer param0,   // IUnknown* optional
        String param1,   // LPCSTR
        byte[] param2,   // LPSTR out
        int cchFileName,   // DWORD
        int param4,   // DWORD
        Pointer param5   // IBindStatusCallback* optional
    );
}
@[Link("urlmon")]
lib Liburlmon
  fun URLDownloadToCacheFileA = URLDownloadToCacheFileA(
    param0 : Void*,   # IUnknown* optional
    param1 : UInt8*,   # LPCSTR
    param2 : UInt8*,   # LPSTR out
    cchFileName : UInt32,   # DWORD
    param4 : UInt32,   # DWORD
    param5 : Void*   # IBindStatusCallback* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef URLDownloadToCacheFileANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Uint32, Pointer<Void>);
typedef URLDownloadToCacheFileADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int, int, Pointer<Void>);
final URLDownloadToCacheFileA = DynamicLibrary.open('urlmon.dll')
    .lookupFunction<URLDownloadToCacheFileANative, URLDownloadToCacheFileADart>('URLDownloadToCacheFileA');
// param0 : IUnknown* optional -> Pointer<Void>
// param1 : LPCSTR -> Pointer<Utf8>
// param2 : LPSTR out -> Pointer<Utf8>
// cchFileName : DWORD -> Uint32
// param4 : DWORD -> Uint32
// param5 : IBindStatusCallback* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function URLDownloadToCacheFileA(
  param0: Pointer;   // IUnknown* optional
  param1: PAnsiChar;   // LPCSTR
  param2: PAnsiChar;   // LPSTR out
  cchFileName: DWORD;   // DWORD
  param4: DWORD;   // DWORD
  param5: Pointer   // IBindStatusCallback* optional
): Integer; stdcall;
  external 'urlmon.dll' name 'URLDownloadToCacheFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "URLDownloadToCacheFileA"
  c_URLDownloadToCacheFileA :: Ptr () -> CString -> CString -> Word32 -> Word32 -> Ptr () -> IO Int32
-- param0 : IUnknown* optional -> Ptr ()
-- param1 : LPCSTR -> CString
-- param2 : LPSTR out -> CString
-- cchFileName : DWORD -> Word32
-- param4 : DWORD -> Word32
-- param5 : IBindStatusCallback* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urldownloadtocachefilea =
  foreign "URLDownloadToCacheFileA"
    ((ptr void) @-> string @-> string @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* param0 : IUnknown* optional -> (ptr void) *)
(* param1 : LPCSTR -> string *)
(* param2 : LPSTR out -> string *)
(* cchFileName : DWORD -> uint32_t *)
(* param4 : DWORD -> uint32_t *)
(* param5 : IBindStatusCallback* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library urlmon (t "urlmon.dll"))
(cffi:use-foreign-library urlmon)

(cffi:defcfun ("URLDownloadToCacheFileA" urldownload-to-cache-file-a :convention :stdcall) :int32
  (param0 :pointer)   ; IUnknown* optional
  (param1 :string)   ; LPCSTR
  (param2 :pointer)   ; LPSTR out
  (cch-file-name :uint32)   ; DWORD
  (param4 :uint32)   ; DWORD
  (param5 :pointer))   ; IBindStatusCallback* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $URLDownloadToCacheFileA = Win32::API::More->new('urlmon',
    'int URLDownloadToCacheFileA(LPVOID param0, LPCSTR param1, LPSTR param2, DWORD cchFileName, DWORD param4, LPVOID param5)');
# my $ret = $URLDownloadToCacheFileA->Call($param0, $param1, $param2, $cchFileName, $param4, $param5);
# param0 : IUnknown* optional -> LPVOID
# param1 : LPCSTR -> LPCSTR
# param2 : LPSTR out -> LPSTR
# cchFileName : DWORD -> DWORD
# param4 : DWORD -> DWORD
# param5 : IBindStatusCallback* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型