ホーム › Networking.WinInet › CreateUrlCacheContainerW

CreateUrlCacheContainerW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

成功した場合は 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  (Unicode / -W)
#include <windows.h>

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

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

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateUrlCacheContainerW(
    <MarshalAs(UnmanagedType.LPWStr)> Name As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpCachePrefix As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszCachePath As String,   ' LPCWSTR 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 : LPCWSTR
' lpCachePrefix : LPCWSTR
' lpszCachePath : LPCWSTR optional
' KBCacheLimit : DWORD
' dwContainerType : DWORD
' dwOptions : DWORD
' pvBuffer : void* optional
' cbBuffer : DWORD* optional
Declare PtrSafe Function CreateUrlCacheContainerW Lib "wininet" ( _
    ByVal Name As LongPtr, _
    ByVal lpCachePrefix As LongPtr, _
    ByVal lpszCachePath As LongPtr, _
    ByVal KBCacheLimit As Long, _
    ByVal dwContainerType As Long, _
    ByVal dwOptions As Long, _
    ByVal pvBuffer As LongPtr, _
    ByVal cbBuffer As LongPtr) 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

CreateUrlCacheContainerW = ctypes.windll.wininet.CreateUrlCacheContainerW
CreateUrlCacheContainerW.restype = wintypes.BOOL
CreateUrlCacheContainerW.argtypes = [
    wintypes.LPCWSTR,  # Name : LPCWSTR
    wintypes.LPCWSTR,  # lpCachePrefix : LPCWSTR
    wintypes.LPCWSTR,  # lpszCachePath : LPCWSTR 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')
CreateUrlCacheContainerW = Fiddle::Function.new(
  lib['CreateUrlCacheContainerW'],
  [
    Fiddle::TYPE_VOIDP,  # Name : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpCachePrefix : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszCachePath : LPCWSTR 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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn CreateUrlCacheContainerW(
        Name: *const u16,  // LPCWSTR
        lpCachePrefix: *const u16,  // LPCWSTR
        lpszCachePath: *const u16,  // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool CreateUrlCacheContainerW([MarshalAs(UnmanagedType.LPWStr)] string Name, [MarshalAs(UnmanagedType.LPWStr)] string lpCachePrefix, [MarshalAs(UnmanagedType.LPWStr)] string lpszCachePath, uint KBCacheLimit, uint dwContainerType, uint dwOptions, IntPtr pvBuffer, IntPtr cbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_CreateUrlCacheContainerW' -Namespace Win32 -PassThru
# $api::CreateUrlCacheContainerW(Name, lpCachePrefix, lpszCachePath, KBCacheLimit, dwContainerType, dwOptions, pvBuffer, cbBuffer)

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

出力引数:

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