ホーム › Networking.WinInet › CreateUrlCacheEntryW

CreateUrlCacheEntryW

関数

URLに対応する新規キャッシュエントリのローカルファイルを作成する(Unicode版)。

DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

名前	型	方向	説明
lpszUrlName	LPCWSTR	in	URL の名前を含む文字列値へのポインター。この文字列には値が含まれている必要があります。空の文字列を指定すると CreateUrlCacheEntry は失敗します。さらに、この文字列にはエスケープ文字を含めてはなりません。
dwExpectedFileSize	DWORD	in	ソースエンティティに対応するデータを格納するために必要なファイルの予想サイズ(TCHAR 単位)。予想サイズが不明な場合は、この値を 0 に設定します。
lpszFileExtension	LPCWSTR	inoptional	ローカルストレージ内のファイルの拡張子名を含む文字列値へのポインター。
lpszFileName	LPWSTR	inout	ファイル名を受け取るバッファーへのポインター。このバッファーは、作成されたファイルのパスを格納できる十分な大きさ(少なくとも MAX_PATH 文字以上の長さ)である必要があります。
dwReserved	DWORD	in	このパラメーターは予約されており、0 にする必要があります。

戻り値の型: BOOL

公式ドキュメント

指定された URL とファイル名拡張子に基づいて、キャッシュエントリを保存するためのローカルファイル名を作成します。(Unicode)

戻り値

関数が成功した場合、TRUE を返します。

関数が失敗した場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

CreateUrlCacheEntry を呼び出した後、アプリケーションはローカルストレージ内のファイルに直接書き込むことができます。ファイルの受信が完全に完了したら、呼び出し元は CommitUrlCacheEntry を呼び出して、エントリをキャッシュにコミットする必要があります。

WinINet は、システムコードページに従って Unicode パラメーターをデコードしようとします。アプリケーションは、Unicode パラメーターがシステムコードページに対して適切にエンコードされていることを確認する必要があります。アプリケーションは、次のコード例に示すように InternetSetOption を使用してシステムコードページを設定できます。

DWORD CP_SHIFT_JIS = 932;  // ANSI/OEM  Japanese, Shift-JIS
InternetSetOption( hRequest, 
                   INTERNET_OPTION_CODEPAGE,
                   &CP_SHIFT_JIS,
                   sizeof(DWORD) );

Unicode パラメーターがシステムコードページに対して適切にエンコードされていない場合、WinINet は UTF8 デコードを試みます。

キャッシュからアイテムを取得する際、そのアイテムをキャッシュに格納するために使用されたシステムコードページは、ユーザーの現在のシステムコードページと一致している必要があります。IE6 以前で動作するアプリケーションでは、システムコードページのデコードに失敗した場合、WinINet は UTF8 デコードを試みます。

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

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

メモ

wininet.h ヘッダーは、CreateUrlCacheEntry を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 CreateUrlCacheEntryW(
    LPCWSTR lpszUrlName,
    DWORD dwExpectedFileSize,
    LPCWSTR lpszFileExtension,   // optional
    LPWSTR lpszFileName,
    DWORD dwReserved
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CreateUrlCacheEntryW(
    [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
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateUrlCacheEntryW(
    <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
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrlName : LPCWSTR
' dwExpectedFileSize : DWORD
' lpszFileExtension : LPCWSTR optional
' lpszFileName : LPWSTR in/out
' dwReserved : DWORD
Declare PtrSafe Function CreateUrlCacheEntryW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr, _
    ByVal dwExpectedFileSize As Long, _
    ByVal lpszFileExtension As LongPtr, _
    ByVal lpszFileName 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

CreateUrlCacheEntryW = ctypes.windll.wininet.CreateUrlCacheEntryW
CreateUrlCacheEntryW.restype = wintypes.BOOL
CreateUrlCacheEntryW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrlName : LPCWSTR
    wintypes.DWORD,  # dwExpectedFileSize : DWORD
    wintypes.LPCWSTR,  # lpszFileExtension : LPCWSTR optional
    wintypes.LPWSTR,  # lpszFileName : LPWSTR in/out
    wintypes.DWORD,  # dwReserved : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
CreateUrlCacheEntryW = Fiddle::Function.new(
  lib['CreateUrlCacheEntryW'],
  [
    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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn CreateUrlCacheEntryW(
        lpszUrlName: *const u16,  // LPCWSTR
        dwExpectedFileSize: u32,  // DWORD
        lpszFileExtension: *const u16,  // LPCWSTR optional
        lpszFileName: *mut u16,  // LPWSTR in/out
        dwReserved: u32  // DWORD
    ) -> 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 CreateUrlCacheEntryW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName, uint dwExpectedFileSize, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileExtension, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFileName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CreateUrlCacheEntryW' -Namespace Win32 -PassThru
# $api::CreateUrlCacheEntryW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved)

#uselib "WININET.dll"
#func global CreateUrlCacheEntryW "CreateUrlCacheEntryW" wptr, wptr, wptr, wptr, wptr
; CreateUrlCacheEntryW lpszUrlName, dwExpectedFileSize, lpszFileExtension, varptr(lpszFileName), dwReserved   ; 戻り値は stat
; lpszUrlName : LPCWSTR -> "wptr"
; dwExpectedFileSize : DWORD -> "wptr"
; lpszFileExtension : LPCWSTR optional -> "wptr"
; lpszFileName : LPWSTR in/out -> "wptr"
; dwReserved : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global CreateUrlCacheEntryW "CreateUrlCacheEntryW" wstr, int, wstr, var, int
; res = CreateUrlCacheEntryW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved)
; lpszUrlName : LPCWSTR -> "wstr"
; dwExpectedFileSize : DWORD -> "int"
; lpszFileExtension : LPCWSTR optional -> "wstr"
; lpszFileName : LPWSTR in/out -> "var"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global CreateUrlCacheEntryW "CreateUrlCacheEntryW" wstr, int, wstr, sptr, int
; res = CreateUrlCacheEntryW(lpszUrlName, dwExpectedFileSize, lpszFileExtension, varptr(lpszFileName), dwReserved)
; lpszUrlName : LPCWSTR -> "wstr"
; dwExpectedFileSize : DWORD -> "int"
; lpszFileExtension : LPCWSTR optional -> "wstr"
; lpszFileName : LPWSTR in/out -> "sptr"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。