ホーム › Networking.WinInet › FindNextUrlCacheEntryExW

FindNextUrlCacheEntryExW

関数

拡張URLキャッシュ列挙で次のエントリを取得する(Unicode版)。

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

シグネチャ

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

BOOL FindNextUrlCacheEntryExW(
    HANDLE hEnumHandle,
    INTERNET_CACHE_ENTRY_INFOW* lpNextCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    void* lpGroupAttributes,   // optional
    DWORD* lpcbGroupAttributes,   // optional
    void* lpReserved   // optional
);

パラメーター

名前	型	方向	説明
hEnumHandle	HANDLE	in	キャッシュ列挙を開始した FindFirstUrlCacheEntryEx によって返されたハンドルです。
lpNextCacheEntryInfo	INTERNET_CACHE_ENTRY_INFOW*	inoutoptional	キャッシュエントリ情報を受け取る INTERNET_CACHE_ENTRY_INFO 構造体へのポインターです。
lpcbCacheEntryInfo	DWORD*	inout	バッファーのサイズをバイト単位で示す変数へのポインターです。
lpGroupAttributes	void*	optional	このパラメーターは予約済みであり、NULL でなければなりません。
lpcbGroupAttributes	DWORD*	optional	このパラメーターは予約済みであり、NULL でなければなりません。
lpReserved	void*	optional	このパラメーターは予約済みです。

戻り値の型: BOOL

公式ドキュメント

FindFirstUrlCacheEntryEx 関数によって開始されたキャッシュ列挙において、次のキャッシュエントリを検索します。(Unicode)

戻り値

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

解説(Remarks)

キャッシュ内の最後の項目が返されるまで、FindNextUrlCacheEntryEx を呼び出し続けます。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 FindNextUrlCacheEntryExW(
    HANDLE hEnumHandle,
    INTERNET_CACHE_ENTRY_INFOW* lpNextCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    void* lpGroupAttributes,   // optional
    DWORD* lpcbGroupAttributes,   // optional
    void* lpReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FindNextUrlCacheEntryExW(
    IntPtr hEnumHandle,   // HANDLE
    IntPtr lpNextCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    ref uint lpcbCacheEntryInfo,   // DWORD* in/out
    IntPtr lpGroupAttributes,   // void* optional
    IntPtr lpcbGroupAttributes,   // DWORD* optional
    IntPtr lpReserved   // void* optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindNextUrlCacheEntryExW(
    hEnumHandle As IntPtr,   ' HANDLE
    lpNextCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    ByRef lpcbCacheEntryInfo As UInteger,   ' DWORD* in/out
    lpGroupAttributes As IntPtr,   ' void* optional
    lpcbGroupAttributes As IntPtr,   ' DWORD* optional
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hEnumHandle : HANDLE
' lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
' lpcbCacheEntryInfo : DWORD* in/out
' lpGroupAttributes : void* optional
' lpcbGroupAttributes : DWORD* optional
' lpReserved : void* optional
Declare PtrSafe Function FindNextUrlCacheEntryExW Lib "wininet" ( _
    ByVal hEnumHandle As LongPtr, _
    ByVal lpNextCacheEntryInfo As LongPtr, _
    ByRef lpcbCacheEntryInfo As Long, _
    ByVal lpGroupAttributes As LongPtr, _
    ByVal lpcbGroupAttributes As LongPtr, _
    ByVal lpReserved 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

FindNextUrlCacheEntryExW = ctypes.windll.wininet.FindNextUrlCacheEntryExW
FindNextUrlCacheEntryExW.restype = wintypes.BOOL
FindNextUrlCacheEntryExW.argtypes = [
    wintypes.HANDLE,  # hEnumHandle : HANDLE
    ctypes.c_void_p,  # lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcbCacheEntryInfo : DWORD* in/out
    ctypes.POINTER(None),  # lpGroupAttributes : void* optional
    ctypes.POINTER(wintypes.DWORD),  # lpcbGroupAttributes : DWORD* optional
    ctypes.POINTER(None),  # lpReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FindNextUrlCacheEntryExW = Fiddle::Function.new(
  lib['FindNextUrlCacheEntryExW'],
  [
    Fiddle::TYPE_VOIDP,  # hEnumHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpGroupAttributes : void* optional
    Fiddle::TYPE_VOIDP,  # lpcbGroupAttributes : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn FindNextUrlCacheEntryExW(
        hEnumHandle: *mut core::ffi::c_void,  // HANDLE
        lpNextCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOW,  // INTERNET_CACHE_ENTRY_INFOW* optional, in/out
        lpcbCacheEntryInfo: *mut u32,  // DWORD* in/out
        lpGroupAttributes: *mut (),  // void* optional
        lpcbGroupAttributes: *mut u32,  // DWORD* optional
        lpReserved: *mut ()  // void* 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 FindNextUrlCacheEntryExW(IntPtr hEnumHandle, IntPtr lpNextCacheEntryInfo, ref uint lpcbCacheEntryInfo, IntPtr lpGroupAttributes, IntPtr lpcbGroupAttributes, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FindNextUrlCacheEntryExW' -Namespace Win32 -PassThru
# $api::FindNextUrlCacheEntryExW(hEnumHandle, lpNextCacheEntryInfo, lpcbCacheEntryInfo, lpGroupAttributes, lpcbGroupAttributes, lpReserved)

#uselib "WININET.dll"
#func global FindNextUrlCacheEntryExW "FindNextUrlCacheEntryExW" wptr, wptr, wptr, wptr, wptr, wptr
; FindNextUrlCacheEntryExW hEnumHandle, varptr(lpNextCacheEntryInfo), varptr(lpcbCacheEntryInfo), lpGroupAttributes, varptr(lpcbGroupAttributes), lpReserved   ; 戻り値は stat
; hEnumHandle : HANDLE -> "wptr"
; lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out -> "wptr"
; lpcbCacheEntryInfo : DWORD* in/out -> "wptr"
; lpGroupAttributes : void* optional -> "wptr"
; lpcbGroupAttributes : DWORD* optional -> "wptr"
; lpReserved : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global FindNextUrlCacheEntryExW "FindNextUrlCacheEntryExW" sptr, var, var, sptr, var, sptr
; res = FindNextUrlCacheEntryExW(hEnumHandle, lpNextCacheEntryInfo, lpcbCacheEntryInfo, lpGroupAttributes, lpcbGroupAttributes, lpReserved)
; hEnumHandle : HANDLE -> "sptr"
; lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out -> "var"
; lpcbCacheEntryInfo : DWORD* in/out -> "var"
; lpGroupAttributes : void* optional -> "sptr"
; lpcbGroupAttributes : DWORD* optional -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global FindNextUrlCacheEntryExW "FindNextUrlCacheEntryExW" sptr, sptr, sptr, sptr, sptr, sptr
; res = FindNextUrlCacheEntryExW(hEnumHandle, varptr(lpNextCacheEntryInfo), varptr(lpcbCacheEntryInfo), lpGroupAttributes, varptr(lpcbGroupAttributes), lpReserved)
; hEnumHandle : HANDLE -> "sptr"
; lpNextCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out -> "sptr"
; lpcbCacheEntryInfo : DWORD* in/out -> "sptr"
; lpGroupAttributes : void* optional -> "sptr"
; lpcbGroupAttributes : DWORD* optional -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。