Win32 API 日本語リファレンス
ホーム › Networking.WinInet › UrlCacheFindFirstEntry

UrlCacheFindFirstEntry

関数
URLキャッシュエントリの列挙を開始する。
DLLWININET.dll呼出規約winapi

シグネチャ

// WININET.dll
#include <windows.h>

DWORD UrlCacheFindFirstEntry(
    LPCWSTR pwszPrefix,   // optional
    DWORD dwFlags,
    DWORD dwFilter,
    LONGLONG GroupId,
    URLCACHE_ENTRY_INFO* pCacheEntryInfo,
    HANDLE* phFind
);

パラメーター

名前型方向説明
pwszPrefixLPCWSTRinoptional列挙対象を絞り込むURLプレフィックスを示すUnicode文字列。NULLで全エントリ。
dwFlagsDWORDin列挙動作を制御するフラグ。
dwFilterDWORDin対象を絞り込むエントリ種別フィルタフラグ。
GroupIdLONGLONGin対象キャッシュグループのID(GROUPID)を示す64ビット値。0で全グループ。
pCacheEntryInfoURLCACHE_ENTRY_INFO*out最初のエントリ情報を受け取るURLCACHE_ENTRY_INFO構造体へのポインタ。
phFindHANDLE*out列挙用ハンドルを受け取るHANDLEへのポインタ。後続のFindNextに使う。

戻り値の型: DWORD

各言語での呼び出し定義

// WININET.dll
#include <windows.h>

DWORD UrlCacheFindFirstEntry(
    LPCWSTR pwszPrefix,   // optional
    DWORD dwFlags,
    DWORD dwFilter,
    LONGLONG GroupId,
    URLCACHE_ENTRY_INFO* pCacheEntryInfo,
    HANDLE* phFind
);
[DllImport("WININET.dll", ExactSpelling = true)]
static extern uint UrlCacheFindFirstEntry(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszPrefix,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint dwFilter,   // DWORD
    long GroupId,   // LONGLONG
    IntPtr pCacheEntryInfo,   // URLCACHE_ENTRY_INFO* out
    IntPtr phFind   // HANDLE* out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function UrlCacheFindFirstEntry(
    <MarshalAs(UnmanagedType.LPWStr)> pwszPrefix As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    dwFilter As UInteger,   ' DWORD
    GroupId As Long,   ' LONGLONG
    pCacheEntryInfo As IntPtr,   ' URLCACHE_ENTRY_INFO* out
    phFind As IntPtr   ' HANDLE* out
) As UInteger
End Function
' pwszPrefix : LPCWSTR optional
' dwFlags : DWORD
' dwFilter : DWORD
' GroupId : LONGLONG
' pCacheEntryInfo : URLCACHE_ENTRY_INFO* out
' phFind : HANDLE* out
Declare PtrSafe Function UrlCacheFindFirstEntry Lib "wininet" ( _
    ByVal pwszPrefix As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwFilter As Long, _
    ByVal GroupId As LongLong, _
    ByVal pCacheEntryInfo As LongPtr, _
    ByVal phFind As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UrlCacheFindFirstEntry = ctypes.windll.wininet.UrlCacheFindFirstEntry
UrlCacheFindFirstEntry.restype = wintypes.DWORD
UrlCacheFindFirstEntry.argtypes = [
    wintypes.LPCWSTR,  # pwszPrefix : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwFilter : DWORD
    ctypes.c_longlong,  # GroupId : LONGLONG
    ctypes.c_void_p,  # pCacheEntryInfo : URLCACHE_ENTRY_INFO* out
    ctypes.c_void_p,  # phFind : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
UrlCacheFindFirstEntry = Fiddle::Function.new(
  lib['UrlCacheFindFirstEntry'],
  [
    Fiddle::TYPE_VOIDP,  # pwszPrefix : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwFilter : DWORD
    Fiddle::TYPE_LONG_LONG,  # GroupId : LONGLONG
    Fiddle::TYPE_VOIDP,  # pCacheEntryInfo : URLCACHE_ENTRY_INFO* out
    Fiddle::TYPE_VOIDP,  # phFind : HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn UrlCacheFindFirstEntry(
        pwszPrefix: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        dwFilter: u32,  // DWORD
        GroupId: i64,  // LONGLONG
        pCacheEntryInfo: *mut URLCACHE_ENTRY_INFO,  // URLCACHE_ENTRY_INFO* out
        phFind: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll")]
public static extern uint UrlCacheFindFirstEntry([MarshalAs(UnmanagedType.LPWStr)] string pwszPrefix, uint dwFlags, uint dwFilter, long GroupId, IntPtr pCacheEntryInfo, IntPtr phFind);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_UrlCacheFindFirstEntry' -Namespace Win32 -PassThru
# $api::UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
#uselib "WININET.dll"
#func global UrlCacheFindFirstEntry "UrlCacheFindFirstEntry" sptr, sptr, sptr, sptr, sptr, sptr
; UrlCacheFindFirstEntry pwszPrefix, dwFlags, dwFilter, GroupId, varptr(pCacheEntryInfo), phFind   ; 戻り値は stat
; pwszPrefix : LPCWSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwFilter : DWORD -> "sptr"
; GroupId : LONGLONG -> "sptr"
; pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> "sptr"
; phFind : HANDLE* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "WININET.dll"
#cfunc global UrlCacheFindFirstEntry "UrlCacheFindFirstEntry" wstr, int, int, int64, var, sptr
; res = UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
; pwszPrefix : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; dwFilter : DWORD -> "int"
; GroupId : LONGLONG -> "int64"
; pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> "var"
; phFind : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数: 
; DWORD UrlCacheFindFirstEntry(LPCWSTR pwszPrefix, DWORD dwFlags, DWORD dwFilter, LONGLONG GroupId, URLCACHE_ENTRY_INFO* pCacheEntryInfo, HANDLE* phFind)
#uselib "WININET.dll"
#cfunc global UrlCacheFindFirstEntry "UrlCacheFindFirstEntry" wstr, int, int, int64, var, intptr
; res = UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
; pwszPrefix : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; dwFilter : DWORD -> "int"
; GroupId : LONGLONG -> "int64"
; pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> "var"
; phFind : HANDLE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procUrlCacheFindFirstEntry = wininet.NewProc("UrlCacheFindFirstEntry")
)

// pwszPrefix (LPCWSTR optional), dwFlags (DWORD), dwFilter (DWORD), GroupId (LONGLONG), pCacheEntryInfo (URLCACHE_ENTRY_INFO* out), phFind (HANDLE* out)
r1, _, err := procUrlCacheFindFirstEntry.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszPrefix))),
	uintptr(dwFlags),
	uintptr(dwFilter),
	uintptr(GroupId),
	uintptr(pCacheEntryInfo),
	uintptr(phFind),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function UrlCacheFindFirstEntry(
  pwszPrefix: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  dwFilter: DWORD;   // DWORD
  GroupId: Int64;   // LONGLONG
  pCacheEntryInfo: Pointer;   // URLCACHE_ENTRY_INFO* out
  phFind: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'WININET.dll' name 'UrlCacheFindFirstEntry';
result := DllCall("WININET\UrlCacheFindFirstEntry"
    , "WStr", pwszPrefix   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "UInt", dwFilter   ; DWORD
    , "Int64", GroupId   ; LONGLONG
    , "Ptr", pCacheEntryInfo   ; URLCACHE_ENTRY_INFO* out
    , "Ptr", phFind   ; HANDLE* out
    , "UInt")   ; return: DWORD
●UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind) = DLL("WININET.dll", "dword UrlCacheFindFirstEntry(char*, dword, dword, int64, void*, void*)")
# 呼び出し: UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
# pwszPrefix : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# dwFilter : DWORD -> "dword"
# GroupId : LONGLONG -> "int64"
# pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> "void*"
# phFind : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn UrlCacheFindFirstEntry(
    pwszPrefix: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // DWORD
    dwFilter: u32, // DWORD
    GroupId: i64, // LONGLONG
    pCacheEntryInfo: [*c]URLCACHE_ENTRY_INFO, // URLCACHE_ENTRY_INFO* out
    phFind: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc UrlCacheFindFirstEntry(
    pwszPrefix: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # DWORD
    dwFilter: uint32,  # DWORD
    GroupId: int64,  # LONGLONG
    pCacheEntryInfo: ptr URLCACHE_ENTRY_INFO,  # URLCACHE_ENTRY_INFO* out
    phFind: pointer  # HANDLE* out
): uint32 {.importc: "UrlCacheFindFirstEntry", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
uint UrlCacheFindFirstEntry(
    const(wchar)* pwszPrefix,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint dwFilter,   // DWORD
    long GroupId,   // LONGLONG
    URLCACHE_ENTRY_INFO* pCacheEntryInfo,   // URLCACHE_ENTRY_INFO* out
    void* phFind   // HANDLE* out
);
ccall((:UrlCacheFindFirstEntry, "WININET.dll"), stdcall, UInt32,
      (Cwstring, UInt32, UInt32, Int64, Ptr{URLCACHE_ENTRY_INFO}, Ptr{Cvoid}),
      pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
# pwszPrefix : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# dwFilter : DWORD -> UInt32
# GroupId : LONGLONG -> Int64
# pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> Ptr{URLCACHE_ENTRY_INFO}
# phFind : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t UrlCacheFindFirstEntry(
    const uint16_t* pwszPrefix,
    uint32_t dwFlags,
    uint32_t dwFilter,
    int64_t GroupId,
    void* pCacheEntryInfo,
    void* phFind);
]]
local wininet = ffi.load("wininet")
-- wininet.UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
-- pwszPrefix : LPCWSTR optional
-- dwFlags : DWORD
-- dwFilter : DWORD
-- GroupId : LONGLONG
-- pCacheEntryInfo : URLCACHE_ENTRY_INFO* out
-- phFind : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const UrlCacheFindFirstEntry = lib.func('__stdcall', 'UrlCacheFindFirstEntry', 'uint32_t', ['str16', 'uint32_t', 'uint32_t', 'int64_t', 'void *', 'void *']);
// UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
// pwszPrefix : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// dwFilter : DWORD -> 'uint32_t'
// GroupId : LONGLONG -> 'int64_t'
// pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> 'void *'
// phFind : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  UrlCacheFindFirstEntry: { parameters: ["buffer", "u32", "u32", "i64", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind)
// pwszPrefix : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// dwFilter : DWORD -> "u32"
// GroupId : LONGLONG -> "i64"
// pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> "pointer"
// phFind : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t UrlCacheFindFirstEntry(
    const uint16_t* pwszPrefix,
    uint32_t dwFlags,
    uint32_t dwFilter,
    int64_t GroupId,
    void* pCacheEntryInfo,
    void* phFind);
C, "WININET.dll");
// $ffi->UrlCacheFindFirstEntry(pwszPrefix, dwFlags, dwFilter, GroupId, pCacheEntryInfo, phFind);
// pwszPrefix : LPCWSTR optional
// dwFlags : DWORD
// dwFilter : DWORD
// GroupId : LONGLONG
// pCacheEntryInfo : URLCACHE_ENTRY_INFO* out
// phFind : HANDLE* out
// 構造体/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);
    int UrlCacheFindFirstEntry(
        WString pwszPrefix,   // LPCWSTR optional
        int dwFlags,   // DWORD
        int dwFilter,   // DWORD
        long GroupId,   // LONGLONG
        Pointer pCacheEntryInfo,   // URLCACHE_ENTRY_INFO* out
        Pointer phFind   // HANDLE* out
    );
}
@[Link("wininet")]
lib LibWININET
  fun UrlCacheFindFirstEntry = UrlCacheFindFirstEntry(
    pwszPrefix : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # DWORD
    dwFilter : UInt32,   # DWORD
    GroupId : Int64,   # LONGLONG
    pCacheEntryInfo : URLCACHE_ENTRY_INFO*,   # URLCACHE_ENTRY_INFO* out
    phFind : Void*   # HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UrlCacheFindFirstEntryNative = Uint32 Function(Pointer<Utf16>, Uint32, Uint32, Int64, Pointer<Void>, Pointer<Void>);
typedef UrlCacheFindFirstEntryDart = int Function(Pointer<Utf16>, int, int, int, Pointer<Void>, Pointer<Void>);
final UrlCacheFindFirstEntry = DynamicLibrary.open('WININET.dll')
    .lookupFunction<UrlCacheFindFirstEntryNative, UrlCacheFindFirstEntryDart>('UrlCacheFindFirstEntry');
// pwszPrefix : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// dwFilter : DWORD -> Uint32
// GroupId : LONGLONG -> Int64
// pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> Pointer<Void>
// phFind : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlCacheFindFirstEntry(
  pwszPrefix: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  dwFilter: DWORD;   // DWORD
  GroupId: Int64;   // LONGLONG
  pCacheEntryInfo: Pointer;   // URLCACHE_ENTRY_INFO* out
  phFind: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'WININET.dll' name 'UrlCacheFindFirstEntry';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlCacheFindFirstEntry"
  c_UrlCacheFindFirstEntry :: CWString -> Word32 -> Word32 -> Int64 -> Ptr () -> Ptr () -> IO Word32
-- pwszPrefix : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- dwFilter : DWORD -> Word32
-- GroupId : LONGLONG -> Int64
-- pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> Ptr ()
-- phFind : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlcachefindfirstentry =
  foreign "UrlCacheFindFirstEntry"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> int64_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* pwszPrefix : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwFilter : DWORD -> uint32_t *)
(* GroupId : LONGLONG -> int64_t *)
(* pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> (ptr void) *)
(* phFind : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("UrlCacheFindFirstEntry" url-cache-find-first-entry :convention :stdcall) :uint32
  (pwsz-prefix (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; DWORD
  (dw-filter :uint32)   ; DWORD
  (group-id :int64)   ; LONGLONG
  (p-cache-entry-info :pointer)   ; URLCACHE_ENTRY_INFO* out
  (ph-find :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlCacheFindFirstEntry = Win32::API::More->new('WININET',
    'DWORD UrlCacheFindFirstEntry(LPCWSTR pwszPrefix, DWORD dwFlags, DWORD dwFilter, INT64 GroupId, LPVOID pCacheEntryInfo, HANDLE phFind)');
# my $ret = $UrlCacheFindFirstEntry->Call($pwszPrefix, $dwFlags, $dwFilter, $GroupId, $pCacheEntryInfo, $phFind);
# pwszPrefix : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# dwFilter : DWORD -> DWORD
# GroupId : LONGLONG -> INT64
# pCacheEntryInfo : URLCACHE_ENTRY_INFO* out -> LPVOID
# phFind : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型