ホーム › Networking.WinInet › CommitUrlCacheEntryA

CommitUrlCacheEntryA

関数

作成したキャッシュファイルをURLキャッシュに登録する(ANSI版)。

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

シグネチャ

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

BOOL CommitUrlCacheEntryA(
    LPCSTR lpszUrlName,
    LPCSTR lpszLocalFileName,   // optional
    FILETIME ExpireTime,
    FILETIME LastModifiedTime,
    DWORD CacheEntryType,
    BYTE* lpHeaderInfo,   // optional
    DWORD cchHeaderInfo,
    LPCSTR lpszFileExtension,   // optional
    LPCSTR lpszOriginalUrl   // optional
);

パラメーター

名前

型

方向

説明

lpszUrlName

LPCSTR

キャッシュエントリのソース名を含む文字列変数へのポインタ。名前文字列は一意でなければならず、エスケープ文字を含めないでください。

lpszLocalFileName

LPCSTR

inoptional

キャッシュ対象となるローカルファイルの名前を含む文字列変数へのポインタ。これは CreateUrlCacheEntryA が返した名前と同じである必要があります。

ExpireTime

FILETIME

キャッシュ対象ファイルの有効期限の日時(グリニッジ標準時)を含む FILETIME 構造体。有効期限の日時が不明な場合は、このパラメーターを 0 に設定します。

LastModifiedTime

FILETIME

キャッシュ対象 URL の最終更新日時(グリニッジ標準時)を含む FILETIME 構造体。最終更新日時が不明な場合は、このパラメーターを 0 に設定します。

CacheEntryType

DWORD

キャッシュエントリの種類とそのプロパティを示すビットマスク。キャッシュエントリの種類には、履歴エントリ(URLHISTORY_CACHE_ENTRY)、Cookie エントリ(COOKIE_CACHE_ENTRY)、通常のキャッシュコンテンツ(NORMAL_CACHE_ENTRY)があります。

このパラメーターには、以下に示すプロパティフラグおよびキャッシュ種別フラグを 0 個以上指定できます。

値	意味
COOKIE_CACHE_ENTRY	Cookie キャッシュエントリ。
EDITED_CACHE_ENTRY	外部から編集されたキャッシュエントリファイル。このキャッシュエントリの種類はスカベンジング(回収)の対象外です。
NORMAL_CACHE_ENTRY	通常のキャッシュエントリ。新しいエントリ用の領域を確保するために削除できます。
SPARSE_CACHE_ENTRY	部分応答のキャッシュエントリ。
STICKY_CACHE_ENTRY	スティッキーキャッシュエントリ。スカベンジングの対象外です。
TRACK_OFFLINE_CACHE_ENTRY	現在は実装されていません。
TRACK_ONLINE_CACHE_ENTRY	現在は実装されていません。
URLHISTORY_CACHE_ENTRY	訪問済みリンクのキャッシュエントリ。

lpHeaderInfo

BYTE*

inoptional

ヘッダー情報を含むバッファーへのポインタ。このパラメーターが NULL でない場合、ヘッダー情報は URL の拡張属性として扱われ、INTERNET_CACHE_ENTRY_INFO 構造体の lpHeaderInfo メンバーで返されます。

cchHeaderInfo

DWORD

ヘッダー情報のサイズ(TCHARs 単位)。 lpHeaderInfo が NULL でない場合、この値はヘッダー情報を格納するバッファーのサイズを示すものとみなされます。アプリケーションはヘッダーをデータの一部として保持し、 lpHeaderInfo に NULL を指定したうえで cchHeaderInfo を渡すこともできます。

lpszFileExtension

LPCSTR

optional

このパラメーターは予約されており、NULL でなければなりません。

lpszOriginalUrl

LPCSTR

inoptional

リダイレクトが発生した場合に、元の URL を含む文字列へのポインタ。

戻り値の型: BOOL

公式ドキュメント

指定したファイルのデータをインターネットキャッシュに格納し、指定した URL に関連付けます。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。以下は想定されるエラー値です。

戻り値	説明
ERROR_DISK_FULL	キャッシュストレージが満杯です。
ERROR_FILE_NOT_FOUND	指定されたローカルファイルが見つかりません。

解説(Remarks)

STICKY_CACHE_ENTRY 型は、キャッシュエントリをスカベンジングの対象外にするために使用します。 CommitUrlCacheEntryA で設定されたエントリの既定の対象外期間は 10 分です。この対象外期間は、 SetUrlCacheEntryInfo 関数の呼び出しにおいて INTERNET_CACHE_ENTRY_INFO 構造体の有効期限パラメーターを設定することで変更できます。

キャッシュストレージが満杯の場合、 CommitUrlCacheEntryA はこの新しいファイル用の領域を確保するためにキャッシュのクリーンアップを実行します。キャッシュエントリが既に存在する場合、そのエントリが使用中でなければ上書きします。エントリは、 RetrieveUrlCacheEntryStream または RetrieveUrlCacheEntryFile のいずれかで取得されたときに使用中となります。

キャッシュにエントリを追加するクライアントは、ヘッダーを少なくとも "HTTP/1.0 200 OK\r\n\r\n" に設定する必要があります。そうでない場合、Microsoft Internet Explorer やその他のクライアントアプリケーションはそのエントリを無視します。

CreateUrlCacheEntryA を呼び出すサンプルコードについては、Caching を参照してください。

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

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

メモ

wininet.h ヘッダーは CommitUrlCacheEntry をエイリアスとして定義しており、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 CommitUrlCacheEntryA(
    LPCSTR lpszUrlName,
    LPCSTR lpszLocalFileName,   // optional
    FILETIME ExpireTime,
    FILETIME LastModifiedTime,
    DWORD CacheEntryType,
    BYTE* lpHeaderInfo,   // optional
    DWORD cchHeaderInfo,
    LPCSTR lpszFileExtension,   // optional
    LPCSTR lpszOriginalUrl   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CommitUrlCacheEntryA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszLocalFileName,   // LPCSTR optional
    FILETIME ExpireTime,   // FILETIME
    FILETIME LastModifiedTime,   // FILETIME
    uint CacheEntryType,   // DWORD
    IntPtr lpHeaderInfo,   // BYTE* optional
    uint cchHeaderInfo,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszFileExtension,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszOriginalUrl   // LPCSTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CommitUrlCacheEntryA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrlName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszLocalFileName As String,   ' LPCSTR optional
    ExpireTime As FILETIME,   ' FILETIME
    LastModifiedTime As FILETIME,   ' FILETIME
    CacheEntryType As UInteger,   ' DWORD
    lpHeaderInfo As IntPtr,   ' BYTE* optional
    cchHeaderInfo As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszFileExtension As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszOriginalUrl As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrlName : LPCSTR
' lpszLocalFileName : LPCSTR optional
' ExpireTime : FILETIME
' LastModifiedTime : FILETIME
' CacheEntryType : DWORD
' lpHeaderInfo : BYTE* optional
' cchHeaderInfo : DWORD
' lpszFileExtension : LPCSTR optional
' lpszOriginalUrl : LPCSTR optional
Declare PtrSafe Function CommitUrlCacheEntryA Lib "wininet" ( _
    ByVal lpszUrlName As String, _
    ByVal lpszLocalFileName As String, _
    ByVal ExpireTime As LongPtr, _
    ByVal LastModifiedTime As LongPtr, _
    ByVal CacheEntryType As Long, _
    ByVal lpHeaderInfo As LongPtr, _
    ByVal cchHeaderInfo As Long, _
    ByVal lpszFileExtension As String, _
    ByVal lpszOriginalUrl As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CommitUrlCacheEntryA = ctypes.windll.wininet.CommitUrlCacheEntryA
CommitUrlCacheEntryA.restype = wintypes.BOOL
CommitUrlCacheEntryA.argtypes = [
    wintypes.LPCSTR,  # lpszUrlName : LPCSTR
    wintypes.LPCSTR,  # lpszLocalFileName : LPCSTR optional
    FILETIME,  # ExpireTime : FILETIME
    FILETIME,  # LastModifiedTime : FILETIME
    wintypes.DWORD,  # CacheEntryType : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpHeaderInfo : BYTE* optional
    wintypes.DWORD,  # cchHeaderInfo : DWORD
    wintypes.LPCSTR,  # lpszFileExtension : LPCSTR optional
    wintypes.LPCSTR,  # lpszOriginalUrl : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
CommitUrlCacheEntryA = Fiddle::Function.new(
  lib['CommitUrlCacheEntryA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszLocalFileName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # ExpireTime : FILETIME
    Fiddle::TYPE_VOIDP,  # LastModifiedTime : FILETIME
    -Fiddle::TYPE_INT,  # CacheEntryType : DWORD
    Fiddle::TYPE_VOIDP,  # lpHeaderInfo : BYTE* optional
    -Fiddle::TYPE_INT,  # cchHeaderInfo : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFileExtension : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszOriginalUrl : LPCSTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn CommitUrlCacheEntryA(
        lpszUrlName: *const u8,  // LPCSTR
        lpszLocalFileName: *const u8,  // LPCSTR optional
        ExpireTime: FILETIME,  // FILETIME
        LastModifiedTime: FILETIME,  // FILETIME
        CacheEntryType: u32,  // DWORD
        lpHeaderInfo: *mut u8,  // BYTE* optional
        cchHeaderInfo: u32,  // DWORD
        lpszFileExtension: *const u8,  // LPCSTR optional
        lpszOriginalUrl: *const u8  // LPCSTR optional
    ) -> 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 CommitUrlCacheEntryA([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, [MarshalAs(UnmanagedType.LPStr)] string lpszLocalFileName, FILETIME ExpireTime, FILETIME LastModifiedTime, uint CacheEntryType, IntPtr lpHeaderInfo, uint cchHeaderInfo, [MarshalAs(UnmanagedType.LPStr)] string lpszFileExtension, [MarshalAs(UnmanagedType.LPStr)] string lpszOriginalUrl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CommitUrlCacheEntryA' -Namespace Win32 -PassThru
# $api::CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)

#uselib "WININET.dll"
#func global CommitUrlCacheEntryA "CommitUrlCacheEntryA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CommitUrlCacheEntryA lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, varptr(lpHeaderInfo), cchHeaderInfo, lpszFileExtension, lpszOriginalUrl   ; 戻り値は stat
; lpszUrlName : LPCSTR -> "sptr"
; lpszLocalFileName : LPCSTR optional -> "sptr"
; ExpireTime : FILETIME -> "sptr"
; LastModifiedTime : FILETIME -> "sptr"
; CacheEntryType : DWORD -> "sptr"
; lpHeaderInfo : BYTE* optional -> "sptr"
; cchHeaderInfo : DWORD -> "sptr"
; lpszFileExtension : LPCSTR optional -> "sptr"
; lpszOriginalUrl : LPCSTR optional -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global CommitUrlCacheEntryA "CommitUrlCacheEntryA" str, str, int, int, int, var, int, str, str
; res = CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
; lpszUrlName : LPCSTR -> "str"
; lpszLocalFileName : LPCSTR optional -> "str"
; ExpireTime : FILETIME -> "int"
; LastModifiedTime : FILETIME -> "int"
; CacheEntryType : DWORD -> "int"
; lpHeaderInfo : BYTE* optional -> "var"
; cchHeaderInfo : DWORD -> "int"
; lpszFileExtension : LPCSTR optional -> "str"
; lpszOriginalUrl : LPCSTR optional -> "str"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global CommitUrlCacheEntryA "CommitUrlCacheEntryA" str, str, int, int, int, sptr, int, str, str
; res = CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, varptr(lpHeaderInfo), cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
; lpszUrlName : LPCSTR -> "str"
; lpszLocalFileName : LPCSTR optional -> "str"
; ExpireTime : FILETIME -> "int"
; LastModifiedTime : FILETIME -> "int"
; CacheEntryType : DWORD -> "int"
; lpHeaderInfo : BYTE* optional -> "sptr"
; cchHeaderInfo : DWORD -> "int"
; lpszFileExtension : LPCSTR optional -> "str"
; lpszOriginalUrl : LPCSTR optional -> "str"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL CommitUrlCacheEntryA(LPCSTR lpszUrlName, LPCSTR lpszLocalFileName, FILETIME ExpireTime, FILETIME LastModifiedTime, DWORD CacheEntryType, BYTE* lpHeaderInfo, DWORD cchHeaderInfo, LPCSTR lpszFileExtension, LPCSTR lpszOriginalUrl)
#uselib "WININET.dll"
#cfunc global CommitUrlCacheEntryA "CommitUrlCacheEntryA" str, str, int, int, int, var, int, str, str
; res = CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
; lpszUrlName : LPCSTR -> "str"
; lpszLocalFileName : LPCSTR optional -> "str"
; ExpireTime : FILETIME -> "int"
; LastModifiedTime : FILETIME -> "int"
; CacheEntryType : DWORD -> "int"
; lpHeaderInfo : BYTE* optional -> "var"
; cchHeaderInfo : DWORD -> "int"
; lpszFileExtension : LPCSTR optional -> "str"
; lpszOriginalUrl : LPCSTR optional -> "str"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CommitUrlCacheEntryA(LPCSTR lpszUrlName, LPCSTR lpszLocalFileName, FILETIME ExpireTime, FILETIME LastModifiedTime, DWORD CacheEntryType, BYTE* lpHeaderInfo, DWORD cchHeaderInfo, LPCSTR lpszFileExtension, LPCSTR lpszOriginalUrl)
#uselib "WININET.dll"
#cfunc global CommitUrlCacheEntryA "CommitUrlCacheEntryA" str, str, int, int, int, intptr, int, str, str
; res = CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, varptr(lpHeaderInfo), cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
; lpszUrlName : LPCSTR -> "str"
; lpszLocalFileName : LPCSTR optional -> "str"
; ExpireTime : FILETIME -> "int"
; LastModifiedTime : FILETIME -> "int"
; CacheEntryType : DWORD -> "int"
; lpHeaderInfo : BYTE* optional -> "intptr"
; cchHeaderInfo : DWORD -> "int"
; lpszFileExtension : LPCSTR optional -> "str"
; lpszOriginalUrl : LPCSTR optional -> "str"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procCommitUrlCacheEntryA = wininet.NewProc("CommitUrlCacheEntryA")
)

// lpszUrlName (LPCSTR), lpszLocalFileName (LPCSTR optional), ExpireTime (FILETIME), LastModifiedTime (FILETIME), CacheEntryType (DWORD), lpHeaderInfo (BYTE* optional), cchHeaderInfo (DWORD), lpszFileExtension (LPCSTR optional), lpszOriginalUrl (LPCSTR optional)
r1, _, err := procCommitUrlCacheEntryA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszUrlName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszLocalFileName))),
	uintptr(ExpireTime),
	uintptr(LastModifiedTime),
	uintptr(CacheEntryType),
	uintptr(lpHeaderInfo),
	uintptr(cchHeaderInfo),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszFileExtension))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszOriginalUrl))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function CommitUrlCacheEntryA(
  lpszUrlName: PAnsiChar;   // LPCSTR
  lpszLocalFileName: PAnsiChar;   // LPCSTR optional
  ExpireTime: FILETIME;   // FILETIME
  LastModifiedTime: FILETIME;   // FILETIME
  CacheEntryType: DWORD;   // DWORD
  lpHeaderInfo: Pointer;   // BYTE* optional
  cchHeaderInfo: DWORD;   // DWORD
  lpszFileExtension: PAnsiChar;   // LPCSTR optional
  lpszOriginalUrl: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'CommitUrlCacheEntryA';

result := DllCall("WININET\CommitUrlCacheEntryA"
    , "AStr", lpszUrlName   ; LPCSTR
    , "AStr", lpszLocalFileName   ; LPCSTR optional
    , "Ptr", ExpireTime   ; FILETIME
    , "Ptr", LastModifiedTime   ; FILETIME
    , "UInt", CacheEntryType   ; DWORD
    , "Ptr", lpHeaderInfo   ; BYTE* optional
    , "UInt", cchHeaderInfo   ; DWORD
    , "AStr", lpszFileExtension   ; LPCSTR optional
    , "AStr", lpszOriginalUrl   ; LPCSTR optional
    , "Int")   ; return: BOOL

●CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl) = DLL("WININET.dll", "bool CommitUrlCacheEntryA(char*, char*, void*, void*, dword, void*, dword, char*, char*)")
# 呼び出し: CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
# lpszUrlName : LPCSTR -> "char*"
# lpszLocalFileName : LPCSTR optional -> "char*"
# ExpireTime : FILETIME -> "void*"
# LastModifiedTime : FILETIME -> "void*"
# CacheEntryType : DWORD -> "dword"
# lpHeaderInfo : BYTE* optional -> "void*"
# cchHeaderInfo : DWORD -> "dword"
# lpszFileExtension : LPCSTR optional -> "char*"
# lpszOriginalUrl : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "wininet" fn CommitUrlCacheEntryA(
    lpszUrlName: [*c]const u8, // LPCSTR
    lpszLocalFileName: [*c]const u8, // LPCSTR optional
    ExpireTime: FILETIME, // FILETIME
    LastModifiedTime: FILETIME, // FILETIME
    CacheEntryType: u32, // DWORD
    lpHeaderInfo: [*c]u8, // BYTE* optional
    cchHeaderInfo: u32, // DWORD
    lpszFileExtension: [*c]const u8, // LPCSTR optional
    lpszOriginalUrl: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;

proc CommitUrlCacheEntryA(
    lpszUrlName: cstring,  # LPCSTR
    lpszLocalFileName: cstring,  # LPCSTR optional
    ExpireTime: FILETIME,  # FILETIME
    LastModifiedTime: FILETIME,  # FILETIME
    CacheEntryType: uint32,  # DWORD
    lpHeaderInfo: ptr uint8,  # BYTE* optional
    cchHeaderInfo: uint32,  # DWORD
    lpszFileExtension: cstring,  # LPCSTR optional
    lpszOriginalUrl: cstring  # LPCSTR optional
): int32 {.importc: "CommitUrlCacheEntryA", stdcall, dynlib: "WININET.dll".}

pragma(lib, "wininet");
extern(Windows)
int CommitUrlCacheEntryA(
    const(char)* lpszUrlName,   // LPCSTR
    const(char)* lpszLocalFileName,   // LPCSTR optional
    FILETIME ExpireTime,   // FILETIME
    FILETIME LastModifiedTime,   // FILETIME
    uint CacheEntryType,   // DWORD
    ubyte* lpHeaderInfo,   // BYTE* optional
    uint cchHeaderInfo,   // DWORD
    const(char)* lpszFileExtension,   // LPCSTR optional
    const(char)* lpszOriginalUrl   // LPCSTR optional
);

ccall((:CommitUrlCacheEntryA, "WININET.dll"), stdcall, Int32,
      (Cstring, Cstring, FILETIME, FILETIME, UInt32, Ptr{UInt8}, UInt32, Cstring, Cstring),
      lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
# lpszUrlName : LPCSTR -> Cstring
# lpszLocalFileName : LPCSTR optional -> Cstring
# ExpireTime : FILETIME -> FILETIME
# LastModifiedTime : FILETIME -> FILETIME
# CacheEntryType : DWORD -> UInt32
# lpHeaderInfo : BYTE* optional -> Ptr{UInt8}
# cchHeaderInfo : DWORD -> UInt32
# lpszFileExtension : LPCSTR optional -> Cstring
# lpszOriginalUrl : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t CommitUrlCacheEntryA(
    const char* lpszUrlName,
    const char* lpszLocalFileName,
    FILETIME ExpireTime,
    FILETIME LastModifiedTime,
    uint32_t CacheEntryType,
    uint8_t* lpHeaderInfo,
    uint32_t cchHeaderInfo,
    const char* lpszFileExtension,
    const char* lpszOriginalUrl);
]]
local wininet = ffi.load("wininet")
-- wininet.CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
-- lpszUrlName : LPCSTR
-- lpszLocalFileName : LPCSTR optional
-- ExpireTime : FILETIME
-- LastModifiedTime : FILETIME
-- CacheEntryType : DWORD
-- lpHeaderInfo : BYTE* optional
-- cchHeaderInfo : DWORD
-- lpszFileExtension : LPCSTR optional
-- lpszOriginalUrl : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const CommitUrlCacheEntryA = lib.func('__stdcall', 'CommitUrlCacheEntryA', 'int32_t', ['str', 'str', 'FILETIME', 'FILETIME', 'uint32_t', 'uint8_t *', 'uint32_t', 'str', 'str']);
// CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
// lpszUrlName : LPCSTR -> 'str'
// lpszLocalFileName : LPCSTR optional -> 'str'
// ExpireTime : FILETIME -> 'FILETIME'
// LastModifiedTime : FILETIME -> 'FILETIME'
// CacheEntryType : DWORD -> 'uint32_t'
// lpHeaderInfo : BYTE* optional -> 'uint8_t *'
// cchHeaderInfo : DWORD -> 'uint32_t'
// lpszFileExtension : LPCSTR optional -> 'str'
// lpszOriginalUrl : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("WININET.dll", {
  CommitUrlCacheEntryA: { parameters: ["buffer", "buffer", "buffer", "buffer", "u32", "pointer", "u32", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl)
// lpszUrlName : LPCSTR -> "buffer"
// lpszLocalFileName : LPCSTR optional -> "buffer"
// ExpireTime : FILETIME -> "buffer"
// LastModifiedTime : FILETIME -> "buffer"
// CacheEntryType : DWORD -> "u32"
// lpHeaderInfo : BYTE* optional -> "pointer"
// cchHeaderInfo : DWORD -> "u32"
// lpszFileExtension : LPCSTR optional -> "buffer"
// lpszOriginalUrl : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t CommitUrlCacheEntryA(
    const char* lpszUrlName,
    const char* lpszLocalFileName,
    FILETIME ExpireTime,
    FILETIME LastModifiedTime,
    uint32_t CacheEntryType,
    uint8_t* lpHeaderInfo,
    uint32_t cchHeaderInfo,
    const char* lpszFileExtension,
    const char* lpszOriginalUrl);
C, "WININET.dll");
// $ffi->CommitUrlCacheEntryA(lpszUrlName, lpszLocalFileName, ExpireTime, LastModifiedTime, CacheEntryType, lpHeaderInfo, cchHeaderInfo, lpszFileExtension, lpszOriginalUrl);
// lpszUrlName : LPCSTR
// lpszLocalFileName : LPCSTR optional
// ExpireTime : FILETIME
// LastModifiedTime : FILETIME
// CacheEntryType : DWORD
// lpHeaderInfo : BYTE* optional
// cchHeaderInfo : DWORD
// lpszFileExtension : LPCSTR optional
// lpszOriginalUrl : LPCSTR 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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.ASCII_OPTIONS);
    boolean CommitUrlCacheEntryA(
        String lpszUrlName,   // LPCSTR
        String lpszLocalFileName,   // LPCSTR optional
        FILETIME /* extends Structure (by value) */ ExpireTime,   // FILETIME
        FILETIME /* extends Structure (by value) */ LastModifiedTime,   // FILETIME
        int CacheEntryType,   // DWORD
        byte[] lpHeaderInfo,   // BYTE* optional
        int cchHeaderInfo,   // DWORD
        String lpszFileExtension,   // LPCSTR optional
        String lpszOriginalUrl   // LPCSTR optional
    );
}

@[Link("wininet")]
lib LibWININET
  fun CommitUrlCacheEntryA = CommitUrlCacheEntryA(
    lpszUrlName : UInt8*,   # LPCSTR
    lpszLocalFileName : UInt8*,   # LPCSTR optional
    ExpireTime : FILETIME,   # FILETIME
    LastModifiedTime : FILETIME,   # FILETIME
    CacheEntryType : UInt32,   # DWORD
    lpHeaderInfo : UInt8*,   # BYTE* optional
    cchHeaderInfo : UInt32,   # DWORD
    lpszFileExtension : UInt8*,   # LPCSTR optional
    lpszOriginalUrl : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CommitUrlCacheEntryANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, FILETIME, FILETIME, Uint32, Pointer<Uint8>, Uint32, Pointer<Utf8>, Pointer<Utf8>);
typedef CommitUrlCacheEntryADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int, int, Pointer<Uint8>, int, Pointer<Utf8>, Pointer<Utf8>);
final CommitUrlCacheEntryA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<CommitUrlCacheEntryANative, CommitUrlCacheEntryADart>('CommitUrlCacheEntryA');
// lpszUrlName : LPCSTR -> Pointer<Utf8>
// lpszLocalFileName : LPCSTR optional -> Pointer<Utf8>
// ExpireTime : FILETIME -> FILETIME
// LastModifiedTime : FILETIME -> FILETIME
// CacheEntryType : DWORD -> Uint32
// lpHeaderInfo : BYTE* optional -> Pointer<Uint8>
// cchHeaderInfo : DWORD -> Uint32
// lpszFileExtension : LPCSTR optional -> Pointer<Utf8>
// lpszOriginalUrl : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function CommitUrlCacheEntryA(
  lpszUrlName: PAnsiChar;   // LPCSTR
  lpszLocalFileName: PAnsiChar;   // LPCSTR optional
  ExpireTime: FILETIME;   // FILETIME
  LastModifiedTime: FILETIME;   // FILETIME
  CacheEntryType: DWORD;   // DWORD
  lpHeaderInfo: Pointer;   // BYTE* optional
  cchHeaderInfo: DWORD;   // DWORD
  lpszFileExtension: PAnsiChar;   // LPCSTR optional
  lpszOriginalUrl: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'CommitUrlCacheEntryA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CommitUrlCacheEntryA"
  c_CommitUrlCacheEntryA :: CString -> CString -> FILETIME -> FILETIME -> Word32 -> Ptr Word8 -> Word32 -> CString -> CString -> IO CInt
-- lpszUrlName : LPCSTR -> CString
-- lpszLocalFileName : LPCSTR optional -> CString
-- ExpireTime : FILETIME -> FILETIME
-- LastModifiedTime : FILETIME -> FILETIME
-- CacheEntryType : DWORD -> Word32
-- lpHeaderInfo : BYTE* optional -> Ptr Word8
-- cchHeaderInfo : DWORD -> Word32
-- lpszFileExtension : LPCSTR optional -> CString
-- lpszOriginalUrl : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。

open Ctypes
open Foreign

let commiturlcacheentrya =
  foreign "CommitUrlCacheEntryA"
    (string @-> string @-> FILETIME @-> FILETIME @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> string @-> string @-> returning int32_t)
(* lpszUrlName : LPCSTR -> string *)
(* lpszLocalFileName : LPCSTR optional -> string *)
(* ExpireTime : FILETIME -> FILETIME *)
(* LastModifiedTime : FILETIME -> FILETIME *)
(* CacheEntryType : DWORD -> uint32_t *)
(* lpHeaderInfo : BYTE* optional -> (ptr uint8_t) *)
(* cchHeaderInfo : DWORD -> uint32_t *)
(* lpszFileExtension : LPCSTR optional -> string *)
(* lpszOriginalUrl : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("CommitUrlCacheEntryA" commit-url-cache-entry-a :convention :stdcall) :int32
  (lpsz-url-name :string)   ; LPCSTR
  (lpsz-local-file-name :string)   ; LPCSTR optional
  (expire-time (:struct filetime))   ; FILETIME
  (last-modified-time (:struct filetime))   ; FILETIME
  (cache-entry-type :uint32)   ; DWORD
  (lp-header-info :pointer)   ; BYTE* optional
  (cch-header-info :uint32)   ; DWORD
  (lpsz-file-extension :string)   ; LPCSTR optional
  (lpsz-original-url :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $CommitUrlCacheEntryA = Win32::API::More->new('WININET',
    'BOOL CommitUrlCacheEntryA(LPCSTR lpszUrlName, LPCSTR lpszLocalFileName, LPVOID ExpireTime, LPVOID LastModifiedTime, DWORD CacheEntryType, LPVOID lpHeaderInfo, DWORD cchHeaderInfo, LPCSTR lpszFileExtension, LPCSTR lpszOriginalUrl)');
# my $ret = $CommitUrlCacheEntryA->Call($lpszUrlName, $lpszLocalFileName, $ExpireTime, $LastModifiedTime, $CacheEntryType, $lpHeaderInfo, $cchHeaderInfo, $lpszFileExtension, $lpszOriginalUrl);
# lpszUrlName : LPCSTR -> LPCSTR
# lpszLocalFileName : LPCSTR optional -> LPCSTR
# ExpireTime : FILETIME -> LPVOID
# LastModifiedTime : FILETIME -> LPVOID
# CacheEntryType : DWORD -> DWORD
# lpHeaderInfo : BYTE* optional -> LPVOID
# cchHeaderInfo : DWORD -> DWORD
# lpszFileExtension : LPCSTR optional -> LPCSTR
# lpszOriginalUrl : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

CommitUrlCacheEntryA

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目