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

SetUrlCacheEntryGroup

関数
URLキャッシュエントリをグループに追加または削除する。
DLLWININET.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL SetUrlCacheEntryGroup(
    LPCSTR lpszUrlName,
    DWORD dwFlags,
    LONGLONG GroupId,
    BYTE* pbGroupAttributes,   // optional
    DWORD cbGroupAttributes,   // optional
    void* lpReserved   // optional
);

パラメーター

名前方向説明
lpszUrlNameLPCSTRinキャッシュされたリソースの URL を指定する、null 終端の文字列値へのポインターです。
dwFlagsDWORDin

エントリをキャッシュグループに追加するか、キャッシュグループから削除するかを決定します。このパラメーターには次のいずれかの値を指定できます。

意味
INTERNET_CACHE_GROUP_ADD
キャッシュエントリをキャッシュグループに追加します。
INTERNET_CACHE_GROUP_REMOVE
エントリをキャッシュグループから削除します。
GroupIdLONGLONGinエントリの追加先または削除元となるキャッシュグループの識別子です。
pbGroupAttributesBYTE*optionalこのパラメーターは予約されており、NULL を指定する必要があります。
cbGroupAttributesDWORDoptionalこのパラメーターは予約されており、0 を指定する必要があります。
lpReservedvoid*optionalこのパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

SetUrlCacheEntryGroup 関数 (wininet.h) は、キャッシュグループにエントリを追加するか、キャッシュグループからエントリを削除します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

1 つのキャッシュエントリは、複数のキャッシュグループに属することができます。

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  (ANSI / -A)
#include <windows.h>

BOOL SetUrlCacheEntryGroup(
    LPCSTR lpszUrlName,
    DWORD dwFlags,
    LONGLONG GroupId,
    BYTE* pbGroupAttributes,   // optional
    DWORD cbGroupAttributes,   // optional
    void* lpReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SetUrlCacheEntryGroup(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlName,   // LPCSTR
    uint dwFlags,   // DWORD
    long GroupId,   // LONGLONG
    IntPtr pbGroupAttributes,   // BYTE* optional
    uint cbGroupAttributes,   // DWORD optional
    IntPtr lpReserved   // void* optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SetUrlCacheEntryGroup(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrlName As String,   ' LPCSTR
    dwFlags As UInteger,   ' DWORD
    GroupId As Long,   ' LONGLONG
    pbGroupAttributes As IntPtr,   ' BYTE* optional
    cbGroupAttributes As UInteger,   ' DWORD optional
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrlName : LPCSTR
' dwFlags : DWORD
' GroupId : LONGLONG
' pbGroupAttributes : BYTE* optional
' cbGroupAttributes : DWORD optional
' lpReserved : void* optional
Declare PtrSafe Function SetUrlCacheEntryGroup Lib "wininet" ( _
    ByVal lpszUrlName As String, _
    ByVal dwFlags As Long, _
    ByVal GroupId As LongLong, _
    ByVal pbGroupAttributes As LongPtr, _
    ByVal cbGroupAttributes As Long, _
    ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetUrlCacheEntryGroup = ctypes.windll.wininet.SetUrlCacheEntryGroup
SetUrlCacheEntryGroup.restype = wintypes.BOOL
SetUrlCacheEntryGroup.argtypes = [
    wintypes.LPCSTR,  # lpszUrlName : LPCSTR
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_longlong,  # GroupId : LONGLONG
    ctypes.POINTER(ctypes.c_ubyte),  # pbGroupAttributes : BYTE* optional
    wintypes.DWORD,  # cbGroupAttributes : DWORD optional
    ctypes.POINTER(None),  # lpReserved : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
SetUrlCacheEntryGroup = Fiddle::Function.new(
  lib['SetUrlCacheEntryGroup'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_LONG_LONG,  # GroupId : LONGLONG
    Fiddle::TYPE_VOIDP,  # pbGroupAttributes : BYTE* optional
    -Fiddle::TYPE_INT,  # cbGroupAttributes : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn SetUrlCacheEntryGroup(
        lpszUrlName: *const u8,  // LPCSTR
        dwFlags: u32,  // DWORD
        GroupId: i64,  // LONGLONG
        pbGroupAttributes: *mut u8,  // BYTE* optional
        cbGroupAttributes: 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.Ansi)]
public static extern bool SetUrlCacheEntryGroup([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, uint dwFlags, long GroupId, IntPtr pbGroupAttributes, uint cbGroupAttributes, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_SetUrlCacheEntryGroup' -Namespace Win32 -PassThru
# $api::SetUrlCacheEntryGroup(lpszUrlName, dwFlags, GroupId, pbGroupAttributes, cbGroupAttributes, lpReserved)
#uselib "WININET.dll"
#func global SetUrlCacheEntryGroup "SetUrlCacheEntryGroup" sptr, sptr, sptr, sptr, sptr, sptr
; SetUrlCacheEntryGroup lpszUrlName, dwFlags, GroupId, varptr(pbGroupAttributes), cbGroupAttributes, lpReserved   ; 戻り値は stat
; lpszUrlName : LPCSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; GroupId : LONGLONG -> "sptr"
; pbGroupAttributes : BYTE* optional -> "sptr"
; cbGroupAttributes : DWORD optional -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global SetUrlCacheEntryGroup "SetUrlCacheEntryGroup" str, int, int64, var, int, sptr
; res = SetUrlCacheEntryGroup(lpszUrlName, dwFlags, GroupId, pbGroupAttributes, cbGroupAttributes, lpReserved)
; lpszUrlName : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; GroupId : LONGLONG -> "int64"
; pbGroupAttributes : BYTE* optional -> "var"
; cbGroupAttributes : DWORD optional -> "int"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SetUrlCacheEntryGroup(LPCSTR lpszUrlName, DWORD dwFlags, LONGLONG GroupId, BYTE* pbGroupAttributes, DWORD cbGroupAttributes, void* lpReserved)
#uselib "WININET.dll"
#cfunc global SetUrlCacheEntryGroup "SetUrlCacheEntryGroup" str, int, int64, var, int, intptr
; res = SetUrlCacheEntryGroup(lpszUrlName, dwFlags, GroupId, pbGroupAttributes, cbGroupAttributes, lpReserved)
; lpszUrlName : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; GroupId : LONGLONG -> "int64"
; pbGroupAttributes : BYTE* optional -> "var"
; cbGroupAttributes : DWORD optional -> "int"
; lpReserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procSetUrlCacheEntryGroup = wininet.NewProc("SetUrlCacheEntryGroup")
)

// lpszUrlName (LPCSTR), dwFlags (DWORD), GroupId (LONGLONG), pbGroupAttributes (BYTE* optional), cbGroupAttributes (DWORD optional), lpReserved (void* optional)
r1, _, err := procSetUrlCacheEntryGroup.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszUrlName))),
	uintptr(dwFlags),
	uintptr(GroupId),
	uintptr(pbGroupAttributes),
	uintptr(cbGroupAttributes),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetUrlCacheEntryGroup(
  lpszUrlName: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  GroupId: Int64;   // LONGLONG
  pbGroupAttributes: Pointer;   // BYTE* optional
  cbGroupAttributes: DWORD;   // DWORD optional
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'WININET.dll' name 'SetUrlCacheEntryGroup';
result := DllCall("WININET\SetUrlCacheEntryGroup"
    , "AStr", lpszUrlName   ; LPCSTR
    , "UInt", dwFlags   ; DWORD
    , "Int64", GroupId   ; LONGLONG
    , "Ptr", pbGroupAttributes   ; BYTE* optional
    , "UInt", cbGroupAttributes   ; DWORD optional
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL
●SetUrlCacheEntryGroup(lpszUrlName, dwFlags, GroupId, pbGroupAttributes, cbGroupAttributes, lpReserved) = DLL("WININET.dll", "bool SetUrlCacheEntryGroup(char*, dword, int64, void*, dword, void*)")
# 呼び出し: SetUrlCacheEntryGroup(lpszUrlName, dwFlags, GroupId, pbGroupAttributes, cbGroupAttributes, lpReserved)
# lpszUrlName : LPCSTR -> "char*"
# dwFlags : DWORD -> "dword"
# GroupId : LONGLONG -> "int64"
# pbGroupAttributes : BYTE* optional -> "void*"
# cbGroupAttributes : DWORD optional -> "dword"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetUrlCacheEntryGroupNative = Int32 Function(Pointer<Utf8>, Uint32, Int64, Pointer<Uint8>, Uint32, Pointer<Void>);
typedef SetUrlCacheEntryGroupDart = int Function(Pointer<Utf8>, int, int, Pointer<Uint8>, int, Pointer<Void>);
final SetUrlCacheEntryGroup = DynamicLibrary.open('WININET.dll')
    .lookupFunction<SetUrlCacheEntryGroupNative, SetUrlCacheEntryGroupDart>('SetUrlCacheEntryGroup');
// lpszUrlName : LPCSTR -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// GroupId : LONGLONG -> Int64
// pbGroupAttributes : BYTE* optional -> Pointer<Uint8>
// cbGroupAttributes : DWORD optional -> Uint32
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetUrlCacheEntryGroup(
  lpszUrlName: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  GroupId: Int64;   // LONGLONG
  pbGroupAttributes: Pointer;   // BYTE* optional
  cbGroupAttributes: DWORD;   // DWORD optional
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'WININET.dll' name 'SetUrlCacheEntryGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetUrlCacheEntryGroup"
  c_SetUrlCacheEntryGroup :: CString -> Word32 -> Int64 -> Ptr Word8 -> Word32 -> Ptr () -> IO CInt
-- lpszUrlName : LPCSTR -> CString
-- dwFlags : DWORD -> Word32
-- GroupId : LONGLONG -> Int64
-- pbGroupAttributes : BYTE* optional -> Ptr Word8
-- cbGroupAttributes : DWORD optional -> Word32
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let seturlcacheentrygroup =
  foreign "SetUrlCacheEntryGroup"
    (string @-> uint32_t @-> int64_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* lpszUrlName : LPCSTR -> string *)
(* dwFlags : DWORD -> uint32_t *)
(* GroupId : LONGLONG -> int64_t *)
(* pbGroupAttributes : BYTE* optional -> (ptr uint8_t) *)
(* cbGroupAttributes : DWORD optional -> uint32_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 ("SetUrlCacheEntryGroup" set-url-cache-entry-group :convention :stdcall) :int32
  (lpsz-url-name :string)   ; LPCSTR
  (dw-flags :uint32)   ; DWORD
  (group-id :int64)   ; LONGLONG
  (pb-group-attributes :pointer)   ; BYTE* optional
  (cb-group-attributes :uint32)   ; DWORD optional
  (lp-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetUrlCacheEntryGroup = Win32::API::More->new('WININET',
    'BOOL SetUrlCacheEntryGroup(LPCSTR lpszUrlName, DWORD dwFlags, INT64 GroupId, LPVOID pbGroupAttributes, DWORD cbGroupAttributes, LPVOID lpReserved)');
# my $ret = $SetUrlCacheEntryGroup->Call($lpszUrlName, $dwFlags, $GroupId, $pbGroupAttributes, $cbGroupAttributes, $lpReserved);
# lpszUrlName : LPCSTR -> LPCSTR
# dwFlags : DWORD -> DWORD
# GroupId : LONGLONG -> INT64
# pbGroupAttributes : BYTE* optional -> LPVOID
# cbGroupAttributes : DWORD optional -> DWORD
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い