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

FindFirstUrlCacheGroup

関数
URLキャッシュグループの列挙を開始し最初のIDを取得する。
DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE FindFirstUrlCacheGroup(
    DWORD dwFlags,
    DWORD dwFilter,
    void* lpSearchCondition,   // optional
    DWORD dwSearchCondition,   // optional
    LONGLONG* lpGroupId,
    void* lpReserved   // optional
);

パラメーター

名前方向説明
dwFlagsDWORDinこのパラメーターは予約されており、0 を指定する必要があります。
dwFilterDWORDin

使用するフィルター。このパラメーターには 0、または次のいずれかの値を指定できます。

意味
CACHEGROUP_SEARCH_ALL
すべてのキャッシュグループを検索します。
CACHEGROUP_SEARCH_BYURL
現在は実装されていません。
lpSearchConditionvoid*optionalこのパラメーターは予約されており、NULL を指定する必要があります。
dwSearchConditionDWORDoptionalこのパラメーターは予約されており、0 を指定する必要があります。
lpGroupIdLONGLONG*out検索条件に一致する最初のキャッシュグループの ID へのポインター。
lpReservedvoid*optionalこのパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: HANDLE

公式ドキュメント

インターネットキャッシュ内のキャッシュグループの列挙を開始します。

戻り値

成功した場合は列挙内の最初の項目への有効なハンドルを返し、それ以外の場合は NULL を返します。特定のエラー情報を取得するには、 GetLastError を呼び出します。一致するファイルが見つからない場合、 GetLastErrorERROR_NO_MORE_FILES を返します。

解説(Remarks)

FindFirstUrlCacheGroup から返されたハンドルは、後続の FindNextUrlCacheGroup の呼び出しで使用されます。列挙の終了時には、アプリケーションは FindCloseUrlCache を呼び出す必要があります。

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

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用することもできません。サーバー実装やサービスでは Microsoft Windows HTTP Services (WinHTTP) を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HANDLE FindFirstUrlCacheGroup(
    DWORD dwFlags,
    DWORD dwFilter,
    void* lpSearchCondition,   // optional
    DWORD dwSearchCondition,   // optional
    LONGLONG* lpGroupId,
    void* lpReserved   // optional
);
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstUrlCacheGroup(
    uint dwFlags,   // DWORD
    uint dwFilter,   // DWORD
    IntPtr lpSearchCondition,   // void* optional
    uint dwSearchCondition,   // DWORD optional
    out long lpGroupId,   // LONGLONG* out
    IntPtr lpReserved   // void* optional
);
<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstUrlCacheGroup(
    dwFlags As UInteger,   ' DWORD
    dwFilter As UInteger,   ' DWORD
    lpSearchCondition As IntPtr,   ' void* optional
    dwSearchCondition As UInteger,   ' DWORD optional
    <Out> ByRef lpGroupId As Long,   ' LONGLONG* out
    lpReserved As IntPtr   ' void* optional
) As IntPtr
End Function
' dwFlags : DWORD
' dwFilter : DWORD
' lpSearchCondition : void* optional
' dwSearchCondition : DWORD optional
' lpGroupId : LONGLONG* out
' lpReserved : void* optional
Declare PtrSafe Function FindFirstUrlCacheGroup Lib "wininet" ( _
    ByVal dwFlags As Long, _
    ByVal dwFilter As Long, _
    ByVal lpSearchCondition As LongPtr, _
    ByVal dwSearchCondition As Long, _
    ByRef lpGroupId As LongLong, _
    ByVal lpReserved As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FindFirstUrlCacheGroup = ctypes.windll.wininet.FindFirstUrlCacheGroup
FindFirstUrlCacheGroup.restype = ctypes.c_void_p
FindFirstUrlCacheGroup.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwFilter : DWORD
    ctypes.POINTER(None),  # lpSearchCondition : void* optional
    wintypes.DWORD,  # dwSearchCondition : DWORD optional
    ctypes.POINTER(ctypes.c_longlong),  # lpGroupId : LONGLONG* out
    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')
FindFirstUrlCacheGroup = Fiddle::Function.new(
  lib['FindFirstUrlCacheGroup'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwFilter : DWORD
    Fiddle::TYPE_VOIDP,  # lpSearchCondition : void* optional
    -Fiddle::TYPE_INT,  # dwSearchCondition : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpGroupId : LONGLONG* out
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "wininet")]
extern "system" {
    fn FindFirstUrlCacheGroup(
        dwFlags: u32,  // DWORD
        dwFilter: u32,  // DWORD
        lpSearchCondition: *mut (),  // void* optional
        dwSearchCondition: u32,  // DWORD optional
        lpGroupId: *mut i64,  // LONGLONG* out
        lpReserved: *mut ()  // void* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll", SetLastError = true)]
public static extern IntPtr FindFirstUrlCacheGroup(uint dwFlags, uint dwFilter, IntPtr lpSearchCondition, uint dwSearchCondition, out long lpGroupId, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FindFirstUrlCacheGroup' -Namespace Win32 -PassThru
# $api::FindFirstUrlCacheGroup(dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, lpGroupId, lpReserved)
#uselib "WININET.dll"
#func global FindFirstUrlCacheGroup "FindFirstUrlCacheGroup" sptr, sptr, sptr, sptr, sptr, sptr
; FindFirstUrlCacheGroup dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, varptr(lpGroupId), lpReserved   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; dwFilter : DWORD -> "sptr"
; lpSearchCondition : void* optional -> "sptr"
; dwSearchCondition : DWORD optional -> "sptr"
; lpGroupId : LONGLONG* out -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global FindFirstUrlCacheGroup "FindFirstUrlCacheGroup" int, int, sptr, int, var, sptr
; res = FindFirstUrlCacheGroup(dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, lpGroupId, lpReserved)
; dwFlags : DWORD -> "int"
; dwFilter : DWORD -> "int"
; lpSearchCondition : void* optional -> "sptr"
; dwSearchCondition : DWORD optional -> "int"
; lpGroupId : LONGLONG* out -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE FindFirstUrlCacheGroup(DWORD dwFlags, DWORD dwFilter, void* lpSearchCondition, DWORD dwSearchCondition, LONGLONG* lpGroupId, void* lpReserved)
#uselib "WININET.dll"
#cfunc global FindFirstUrlCacheGroup "FindFirstUrlCacheGroup" int, int, intptr, int, var, intptr
; res = FindFirstUrlCacheGroup(dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, lpGroupId, lpReserved)
; dwFlags : DWORD -> "int"
; dwFilter : DWORD -> "int"
; lpSearchCondition : void* optional -> "intptr"
; dwSearchCondition : DWORD optional -> "int"
; lpGroupId : LONGLONG* out -> "var"
; lpReserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFindFirstUrlCacheGroup = wininet.NewProc("FindFirstUrlCacheGroup")
)

// dwFlags (DWORD), dwFilter (DWORD), lpSearchCondition (void* optional), dwSearchCondition (DWORD optional), lpGroupId (LONGLONG* out), lpReserved (void* optional)
r1, _, err := procFindFirstUrlCacheGroup.Call(
	uintptr(dwFlags),
	uintptr(dwFilter),
	uintptr(lpSearchCondition),
	uintptr(dwSearchCondition),
	uintptr(lpGroupId),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function FindFirstUrlCacheGroup(
  dwFlags: DWORD;   // DWORD
  dwFilter: DWORD;   // DWORD
  lpSearchCondition: Pointer;   // void* optional
  dwSearchCondition: DWORD;   // DWORD optional
  lpGroupId: Pointer;   // LONGLONG* out
  lpReserved: Pointer   // void* optional
): THandle; stdcall;
  external 'WININET.dll' name 'FindFirstUrlCacheGroup';
result := DllCall("WININET\FindFirstUrlCacheGroup"
    , "UInt", dwFlags   ; DWORD
    , "UInt", dwFilter   ; DWORD
    , "Ptr", lpSearchCondition   ; void* optional
    , "UInt", dwSearchCondition   ; DWORD optional
    , "Ptr", lpGroupId   ; LONGLONG* out
    , "Ptr", lpReserved   ; void* optional
    , "Ptr")   ; return: HANDLE
●FindFirstUrlCacheGroup(dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, lpGroupId, lpReserved) = DLL("WININET.dll", "void* FindFirstUrlCacheGroup(dword, dword, void*, dword, void*, void*)")
# 呼び出し: FindFirstUrlCacheGroup(dwFlags, dwFilter, lpSearchCondition, dwSearchCondition, lpGroupId, lpReserved)
# dwFlags : DWORD -> "dword"
# dwFilter : DWORD -> "dword"
# lpSearchCondition : void* optional -> "void*"
# dwSearchCondition : DWORD optional -> "dword"
# lpGroupId : LONGLONG* out -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FindFirstUrlCacheGroupNative = Pointer<Void> Function(Uint32, Uint32, Pointer<Void>, Uint32, Pointer<Int64>, Pointer<Void>);
typedef FindFirstUrlCacheGroupDart = Pointer<Void> Function(int, int, Pointer<Void>, int, Pointer<Int64>, Pointer<Void>);
final FindFirstUrlCacheGroup = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FindFirstUrlCacheGroupNative, FindFirstUrlCacheGroupDart>('FindFirstUrlCacheGroup');
// dwFlags : DWORD -> Uint32
// dwFilter : DWORD -> Uint32
// lpSearchCondition : void* optional -> Pointer<Void>
// dwSearchCondition : DWORD optional -> Uint32
// lpGroupId : LONGLONG* out -> Pointer<Int64>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindFirstUrlCacheGroup(
  dwFlags: DWORD;   // DWORD
  dwFilter: DWORD;   // DWORD
  lpSearchCondition: Pointer;   // void* optional
  dwSearchCondition: DWORD;   // DWORD optional
  lpGroupId: Pointer;   // LONGLONG* out
  lpReserved: Pointer   // void* optional
): THandle; stdcall;
  external 'WININET.dll' name 'FindFirstUrlCacheGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindFirstUrlCacheGroup"
  c_FindFirstUrlCacheGroup :: Word32 -> Word32 -> Ptr () -> Word32 -> Ptr Int64 -> Ptr () -> IO (Ptr ())
-- dwFlags : DWORD -> Word32
-- dwFilter : DWORD -> Word32
-- lpSearchCondition : void* optional -> Ptr ()
-- dwSearchCondition : DWORD optional -> Word32
-- lpGroupId : LONGLONG* out -> Ptr Int64
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let findfirsturlcachegroup =
  foreign "FindFirstUrlCacheGroup"
    (uint32_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr int64_t) @-> (ptr void) @-> returning (ptr void))
(* dwFlags : DWORD -> uint32_t *)
(* dwFilter : DWORD -> uint32_t *)
(* lpSearchCondition : void* optional -> (ptr void) *)
(* dwSearchCondition : DWORD optional -> uint32_t *)
(* lpGroupId : LONGLONG* out -> (ptr int64_t) *)
(* lpReserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("FindFirstUrlCacheGroup" find-first-url-cache-group :convention :stdcall) :pointer
  (dw-flags :uint32)   ; DWORD
  (dw-filter :uint32)   ; DWORD
  (lp-search-condition :pointer)   ; void* optional
  (dw-search-condition :uint32)   ; DWORD optional
  (lp-group-id :pointer)   ; LONGLONG* out
  (lp-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindFirstUrlCacheGroup = Win32::API::More->new('WININET',
    'HANDLE FindFirstUrlCacheGroup(DWORD dwFlags, DWORD dwFilter, LPVOID lpSearchCondition, DWORD dwSearchCondition, LPVOID lpGroupId, LPVOID lpReserved)');
# my $ret = $FindFirstUrlCacheGroup->Call($dwFlags, $dwFilter, $lpSearchCondition, $dwSearchCondition, $lpGroupId, $lpReserved);
# dwFlags : DWORD -> DWORD
# dwFilter : DWORD -> DWORD
# lpSearchCondition : void* optional -> LPVOID
# dwSearchCondition : DWORD optional -> DWORD
# lpGroupId : LONGLONG* out -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。