ホーム › Networking.WinInet › GetUrlCacheConfigInfoW

GetUrlCacheConfigInfoW

関数

URLキャッシュの構成情報を取得する(Unicode版)。

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

シグネチャ

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

BOOL GetUrlCacheConfigInfoW(
    INTERNET_CACHE_CONFIG_INFOW* lpCacheConfigInfo,
    DWORD* lpcbCacheConfigInfo,   // optional
    CACHE_CONFIG dwFieldControl
);

パラメーター

名前

型

方向

説明

lpCacheConfigInfo

INTERNET_CACHE_CONFIG_INFOW*

inout

キャッシュ構成に関する情報を受け取る INTERNET_CACHE_CONFIG_INFO 構造体へのポインターです。構造体の dwStructSize フィールドには、 INTERNET_CACHE_CONFIG_INFO のサイズを設定しておく必要があります。

lpcbCacheConfigInfo

DWORD*

optional

このパラメーターは予約されており、NULL を指定する必要があります。

dwFieldControl

CACHE_CONFIG

関数の動作を、次のいずれかの値で指定します。

値	意味
CACHE_CONFIG_FORCE_CLEANUP_FC 0x00000020	使用されません。
CACHE_CONFIG_DISK_CACHE_PATHS_FC 0x00000040	使用されません。
CACHE_CONFIG_SYNC_MODE_FC 0x00000080	予約されています。
CACHE_CONFIG_CONTENT_PATHS_FC 0x00000100	lpCachedConfigInfo パラメーターで指定された INTERNET_CACHE_CONFIG_INFO 構造体の CachePath フィールドに、コンテンツパスを示す文字列へのポインターが格納されます。これは CACHE_CONFIG_HISTORY_PATHS_FC または CACHE_CONFIG_COOKIES_PATHS_FC と同時には使用できません。
CACHE_CONFIG_HISTORY_PATHS_FC 0x00000400	lpCachedConfigInfo パラメーターで指定された INTERNET_CACHE_CONFIG_INFO 構造体の CachePath フィールドに、履歴パスを示す文字列へのポインターが格納されます。これは CACHE_CONFIG_CONTENT_PATHS_FC または CACHE_CONFIG_COOKIES_PATHS_FC と同時には使用できません。
CACHE_CONFIG_COOKIES_PATHS_FC 0x00000200	lpCachedConfigInfo パラメーターで指定された INTERNET_CACHE_CONFIG_INFO 構造体の CachePath フィールドに、Cookie パスを示す文字列へのポインターが格納されます。これは CACHE_CONFIG_CONTENT_PATHS_FC または CACHE_CONFIG_HISTORY_PATHS_FC と同時には使用できません。
CACHE_CONFIG_QUOTA_FC 0x00000800	lpCachedConfigInfo で指定された INTERNET_CACHE_CONFIG_INFO 構造体の dwQuota フィールドに、dwContainer フィールドで指定されたコンテナーのキャッシュ上限が設定されます。
CACHE_CONFIG_USER_MODE_FC 0x00001000	予約されています。
CACHE_CONFIG_CONTENT_USAGE_FC 0x00002000	lpCachedConfigInfo で指定された INTERNET_CACHE_CONFIG_INFO 構造体の dwNormalUsage フィールドに、dwContainer フィールドで指定されたコンテナーのキャッシュサイズが設定されます。
CACHE_CONFIG_STICKY_CONTENT_USAGE_FC 0x00004000	lpCachedConfigInfo で指定された INTERNET_CACHE_CONFIG_INFO 構造体の dwExemptUsage フィールドに、dwContainer フィールドで指定されたコンテナーの exempt usage(スカベンジングの対象外となるバイト数)が設定されます。(このフィールドはコンテンツコンテナーである必要があります。)

戻り値の型: BOOL

公式ドキュメント

キャッシュ構成に関する情報を取得します。(Unicode)

戻り値

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

解説(Remarks)

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

メモ

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUrlCacheConfigInfoW(
    IntPtr lpCacheConfigInfo,   // INTERNET_CACHE_CONFIG_INFOW* in/out
    IntPtr lpcbCacheConfigInfo,   // DWORD* optional
    uint dwFieldControl   // CACHE_CONFIG
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUrlCacheConfigInfoW(
    lpCacheConfigInfo As IntPtr,   ' INTERNET_CACHE_CONFIG_INFOW* in/out
    lpcbCacheConfigInfo As IntPtr,   ' DWORD* optional
    dwFieldControl As UInteger   ' CACHE_CONFIG
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out
' lpcbCacheConfigInfo : DWORD* optional
' dwFieldControl : CACHE_CONFIG
Declare PtrSafe Function GetUrlCacheConfigInfoW Lib "wininet" ( _
    ByVal lpCacheConfigInfo As LongPtr, _
    ByVal lpcbCacheConfigInfo As LongPtr, _
    ByVal dwFieldControl 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

GetUrlCacheConfigInfoW = ctypes.windll.wininet.GetUrlCacheConfigInfoW
GetUrlCacheConfigInfoW.restype = wintypes.BOOL
GetUrlCacheConfigInfoW.argtypes = [
    ctypes.c_void_p,  # lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcbCacheConfigInfo : DWORD* optional
    wintypes.DWORD,  # dwFieldControl : CACHE_CONFIG
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
GetUrlCacheConfigInfoW = Fiddle::Function.new(
  lib['GetUrlCacheConfigInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheConfigInfo : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFieldControl : CACHE_CONFIG
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheConfigInfoW(
        lpCacheConfigInfo: *mut INTERNET_CACHE_CONFIG_INFOW,  // INTERNET_CACHE_CONFIG_INFOW* in/out
        lpcbCacheConfigInfo: *mut u32,  // DWORD* optional
        dwFieldControl: u32  // CACHE_CONFIG
    ) -> 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 GetUrlCacheConfigInfoW(IntPtr lpCacheConfigInfo, IntPtr lpcbCacheConfigInfo, uint dwFieldControl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheConfigInfoW' -Namespace Win32 -PassThru
# $api::GetUrlCacheConfigInfoW(lpCacheConfigInfo, lpcbCacheConfigInfo, dwFieldControl)

#uselib "WININET.dll"
#func global GetUrlCacheConfigInfoW "GetUrlCacheConfigInfoW" wptr, wptr, wptr
; GetUrlCacheConfigInfoW varptr(lpCacheConfigInfo), varptr(lpcbCacheConfigInfo), dwFieldControl   ; 戻り値は stat
; lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out -> "wptr"
; lpcbCacheConfigInfo : DWORD* optional -> "wptr"
; dwFieldControl : CACHE_CONFIG -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global GetUrlCacheConfigInfoW "GetUrlCacheConfigInfoW" var, var, int
; res = GetUrlCacheConfigInfoW(lpCacheConfigInfo, lpcbCacheConfigInfo, dwFieldControl)
; lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out -> "var"
; lpcbCacheConfigInfo : DWORD* optional -> "var"
; dwFieldControl : CACHE_CONFIG -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global GetUrlCacheConfigInfoW "GetUrlCacheConfigInfoW" sptr, sptr, int
; res = GetUrlCacheConfigInfoW(varptr(lpCacheConfigInfo), varptr(lpcbCacheConfigInfo), dwFieldControl)
; lpCacheConfigInfo : INTERNET_CACHE_CONFIG_INFOW* in/out -> "sptr"
; lpcbCacheConfigInfo : DWORD* optional -> "sptr"
; dwFieldControl : CACHE_CONFIG -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。