ホーム › Networking.WinInet › CreateUrlCacheEntryA

CreateUrlCacheEntryA

関数

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

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

シグネチャ

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

BOOL CreateUrlCacheEntryA(
    LPCSTR lpszUrlName,
    DWORD dwExpectedFileSize,
    LPCSTR lpszFileExtension,   // optional
    LPSTR lpszFileName,
    DWORD dwReserved
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功すると、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 やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

Note 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  (ANSI / -A)
#include <windows.h>

BOOL CreateUrlCacheEntryA(
    LPCSTR lpszUrlName,
    DWORD dwExpectedFileSize,
    LPCSTR lpszFileExtension,   // optional
    LPSTR lpszFileName,
    DWORD dwReserved
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateUrlCacheEntryA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlName,   // LPCSTR
    uint dwExpectedFileSize,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszFileExtension,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFileName,   // LPSTR in/out
    uint dwReserved   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateUrlCacheEntryA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrlName As String,   ' LPCSTR
    dwExpectedFileSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszFileExtension As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszFileName As System.Text.StringBuilder,   ' LPSTR in/out
    dwReserved As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

CreateUrlCacheEntryA = ctypes.windll.wininet.CreateUrlCacheEntryA
CreateUrlCacheEntryA.restype = wintypes.BOOL
CreateUrlCacheEntryA.argtypes = [
    wintypes.LPCSTR,  # lpszUrlName : LPCSTR
    wintypes.DWORD,  # dwExpectedFileSize : DWORD
    wintypes.LPCSTR,  # lpszFileExtension : LPCSTR optional
    wintypes.LPSTR,  # lpszFileName : LPSTR 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')
CreateUrlCacheEntryA = Fiddle::Function.new(
  lib['CreateUrlCacheEntryA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCSTR
    -Fiddle::TYPE_INT,  # dwExpectedFileSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFileExtension : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszFileName : LPSTR in/out
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn CreateUrlCacheEntryA(
        lpszUrlName: *const u8,  // LPCSTR
        dwExpectedFileSize: u32,  // DWORD
        lpszFileExtension: *const u8,  // LPCSTR optional
        lpszFileName: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool CreateUrlCacheEntryA([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, uint dwExpectedFileSize, [MarshalAs(UnmanagedType.LPStr)] string lpszFileExtension, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFileName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CreateUrlCacheEntryA' -Namespace Win32 -PassThru
# $api::CreateUrlCacheEntryA(lpszUrlName, dwExpectedFileSize, lpszFileExtension, lpszFileName, dwReserved)

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

出力引数:

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