ホーム › Networking.WinInet › CreateUrlCacheContainerA

CreateUrlCacheContainerA

関数

URLキャッシュコンテナを作成する。

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

シグネチャ

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

BOOL CreateUrlCacheContainerA(
    LPCSTR Name,
    LPCSTR lpCachePrefix,
    LPCSTR lpszCachePath,   // optional
    DWORD KBCacheLimit,
    DWORD dwContainerType,
    DWORD dwOptions,
    void* pvBuffer,   // optional
    DWORD* cbBuffer   // optional
);

パラメーター

名前	型	方向	説明
Name	LPCSTR	in	キャッシュに付ける名前。
lpCachePrefix	LPCSTR	in	キャッシュの基となるキャッシュプレフィックス。
lpszCachePath	LPCSTR	inoptional	キャッシュを作成するキャッシュプレフィックス。
KBCacheLimit	DWORD	in	キャッシュのサイズ上限(キロバイト単位の整数値)。既定のサイズを使用する場合は 0。
dwContainerType	DWORD	in	キャッシュの基となるコンテナタイプ。
dwOptions	DWORD	in	このパラメーターは予約されており、0 を指定する必要があります。
pvBuffer	void*	optional	このパラメーターは予約されており、NULL を指定する必要があります。
cbBuffer	DWORD*	optional	このパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

指定されたキャッシュパスに、指定された名前、キャッシュプレフィックス、コンテナタイプに基づいてキャッシュエントリを保持するキャッシュコンテナを作成します。(ANSI)

戻り値

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

解説(Remarks)

メモ

winineti.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CreateUrlCacheContainer を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateUrlCacheContainerA(
    LPCSTR Name,
    LPCSTR lpCachePrefix,
    LPCSTR lpszCachePath,   // optional
    DWORD KBCacheLimit,
    DWORD dwContainerType,
    DWORD dwOptions,
    void* pvBuffer,   // optional
    DWORD* cbBuffer   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateUrlCacheContainerA(
    [MarshalAs(UnmanagedType.LPStr)] string Name,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpCachePrefix,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszCachePath,   // LPCSTR optional
    uint KBCacheLimit,   // DWORD
    uint dwContainerType,   // DWORD
    uint dwOptions,   // DWORD
    IntPtr pvBuffer,   // void* optional
    IntPtr cbBuffer   // DWORD* optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateUrlCacheContainerA(
    <MarshalAs(UnmanagedType.LPStr)> Name As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpCachePrefix As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszCachePath As String,   ' LPCSTR optional
    KBCacheLimit As UInteger,   ' DWORD
    dwContainerType As UInteger,   ' DWORD
    dwOptions As UInteger,   ' DWORD
    pvBuffer As IntPtr,   ' void* optional
    cbBuffer As IntPtr   ' DWORD* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Name : LPCSTR
' lpCachePrefix : LPCSTR
' lpszCachePath : LPCSTR optional
' KBCacheLimit : DWORD
' dwContainerType : DWORD
' dwOptions : DWORD
' pvBuffer : void* optional
' cbBuffer : DWORD* optional
Declare PtrSafe Function CreateUrlCacheContainerA Lib "wininet" ( _
    ByVal Name As String, _
    ByVal lpCachePrefix As String, _
    ByVal lpszCachePath As String, _
    ByVal KBCacheLimit As Long, _
    ByVal dwContainerType As Long, _
    ByVal dwOptions As Long, _
    ByVal pvBuffer As LongPtr, _
    ByVal cbBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateUrlCacheContainerA = ctypes.windll.wininet.CreateUrlCacheContainerA
CreateUrlCacheContainerA.restype = wintypes.BOOL
CreateUrlCacheContainerA.argtypes = [
    wintypes.LPCSTR,  # Name : LPCSTR
    wintypes.LPCSTR,  # lpCachePrefix : LPCSTR
    wintypes.LPCSTR,  # lpszCachePath : LPCSTR optional
    wintypes.DWORD,  # KBCacheLimit : DWORD
    wintypes.DWORD,  # dwContainerType : DWORD
    wintypes.DWORD,  # dwOptions : DWORD
    ctypes.POINTER(None),  # pvBuffer : void* optional
    ctypes.POINTER(wintypes.DWORD),  # cbBuffer : DWORD* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
CreateUrlCacheContainerA = Fiddle::Function.new(
  lib['CreateUrlCacheContainerA'],
  [
    Fiddle::TYPE_VOIDP,  # Name : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpCachePrefix : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszCachePath : LPCSTR optional
    -Fiddle::TYPE_INT,  # KBCacheLimit : DWORD
    -Fiddle::TYPE_INT,  # dwContainerType : DWORD
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
    Fiddle::TYPE_VOIDP,  # pvBuffer : void* optional
    Fiddle::TYPE_VOIDP,  # cbBuffer : DWORD* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn CreateUrlCacheContainerA(
        Name: *const u8,  // LPCSTR
        lpCachePrefix: *const u8,  // LPCSTR
        lpszCachePath: *const u8,  // LPCSTR optional
        KBCacheLimit: u32,  // DWORD
        dwContainerType: u32,  // DWORD
        dwOptions: u32,  // DWORD
        pvBuffer: *mut (),  // void* optional
        cbBuffer: *mut u32  // DWORD* 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 CreateUrlCacheContainerA([MarshalAs(UnmanagedType.LPStr)] string Name, [MarshalAs(UnmanagedType.LPStr)] string lpCachePrefix, [MarshalAs(UnmanagedType.LPStr)] string lpszCachePath, uint KBCacheLimit, uint dwContainerType, uint dwOptions, IntPtr pvBuffer, IntPtr cbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CreateUrlCacheContainerA' -Namespace Win32 -PassThru
# $api::CreateUrlCacheContainerA(Name, lpCachePrefix, lpszCachePath, KBCacheLimit, dwContainerType, dwOptions, pvBuffer, cbBuffer)

#uselib "WININET.dll"
#func global CreateUrlCacheContainerA "CreateUrlCacheContainerA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CreateUrlCacheContainerA Name, lpCachePrefix, lpszCachePath, KBCacheLimit, dwContainerType, dwOptions, pvBuffer, varptr(cbBuffer)   ; 戻り値は stat
; Name : LPCSTR -> "sptr"
; lpCachePrefix : LPCSTR -> "sptr"
; lpszCachePath : LPCSTR optional -> "sptr"
; KBCacheLimit : DWORD -> "sptr"
; dwContainerType : DWORD -> "sptr"
; dwOptions : DWORD -> "sptr"
; pvBuffer : void* optional -> "sptr"
; cbBuffer : DWORD* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global CreateUrlCacheContainerA "CreateUrlCacheContainerA" str, str, str, int, int, int, sptr, var
; res = CreateUrlCacheContainerA(Name, lpCachePrefix, lpszCachePath, KBCacheLimit, dwContainerType, dwOptions, pvBuffer, cbBuffer)
; Name : LPCSTR -> "str"
; lpCachePrefix : LPCSTR -> "str"
; lpszCachePath : LPCSTR optional -> "str"
; KBCacheLimit : DWORD -> "int"
; dwContainerType : DWORD -> "int"
; dwOptions : DWORD -> "int"
; pvBuffer : void* optional -> "sptr"
; cbBuffer : DWORD* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global CreateUrlCacheContainerA "CreateUrlCacheContainerA" str, str, str, int, int, int, sptr, sptr
; res = CreateUrlCacheContainerA(Name, lpCachePrefix, lpszCachePath, KBCacheLimit, dwContainerType, dwOptions, pvBuffer, varptr(cbBuffer))
; Name : LPCSTR -> "str"
; lpCachePrefix : LPCSTR -> "str"
; lpszCachePath : LPCSTR optional -> "str"
; KBCacheLimit : DWORD -> "int"
; dwContainerType : DWORD -> "int"
; dwOptions : DWORD -> "int"
; pvBuffer : void* optional -> "sptr"
; cbBuffer : DWORD* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。