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

SetUrlCacheGroupAttributeW

関数
URLキャッシュグループの属性情報を設定する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetUrlCacheGroupAttributeW(
    LONGLONG gid,
    DWORD dwFlags,   // optional
    DWORD dwAttributes,
    INTERNET_CACHE_GROUP_INFOW* lpGroupInfo,
    void* lpReserved   // optional
);

パラメーター

名前方向説明
gidLONGLONGinキャッシュグループの識別子です。
dwFlagsDWORDoptionalこのパラメーターは予約されており、0 でなければなりません。
dwAttributesDWORDin

設定する属性です。このパラメーターには、次のいずれかの値を指定できます。

意味
CACHEGROUP_ATTRIBUTE_FLAG
キャッシュグループに関連付けられたフラグを設定または取得します。
CACHEGROUP_ATTRIBUTE_GROUPNAME
キャッシュグループのグループ名を設定または取得します。
CACHEGROUP_ATTRIBUTE_QUOTA
キャッシュグループに関連付けられたディスククォータを設定または取得します。
CACHEGROUP_ATTRIBUTE_STORAGE
キャッシュグループに関連付けられたグループ所有者のストレージを設定または取得します。
CACHEGROUP_ATTRIBUTE_TYPE
キャッシュグループの種類を設定または取得します。
CACHEGROUP_READWRITE_MASK
キャッシュグループの種類、ディスククォータ、グループ名、所有者ストレージの各属性を設定します。
lpGroupInfoINTERNET_CACHE_GROUP_INFOW*in格納する属性情報を指定する INTERNET_CACHE_GROUP_INFO 構造体へのポインターです。
lpReservedvoid*optionalこのパラメーターは予約されており、NULL でなければなりません。

戻り値の型: BOOL

公式ドキュメント

指定したキャッシュグループの属性情報を設定します。(Unicode)

戻り値

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

解説(Remarks)

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

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetUrlCacheGroupAttribute を定義します。エンコード中立のエイリアスと、エンコード中立でないコードを混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、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 SetUrlCacheGroupAttributeW(
    LONGLONG gid,
    DWORD dwFlags,   // optional
    DWORD dwAttributes,
    INTERNET_CACHE_GROUP_INFOW* lpGroupInfo,
    void* lpReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetUrlCacheGroupAttributeW(
    long gid,   // LONGLONG
    uint dwFlags,   // DWORD optional
    uint dwAttributes,   // DWORD
    IntPtr lpGroupInfo,   // INTERNET_CACHE_GROUP_INFOW*
    IntPtr lpReserved   // void* optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetUrlCacheGroupAttributeW(
    gid As Long,   ' LONGLONG
    dwFlags As UInteger,   ' DWORD optional
    dwAttributes As UInteger,   ' DWORD
    lpGroupInfo As IntPtr,   ' INTERNET_CACHE_GROUP_INFOW*
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' gid : LONGLONG
' dwFlags : DWORD optional
' dwAttributes : DWORD
' lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*
' lpReserved : void* optional
Declare PtrSafe Function SetUrlCacheGroupAttributeW Lib "wininet" ( _
    ByVal gid As LongLong, _
    ByVal dwFlags As Long, _
    ByVal dwAttributes As Long, _
    ByVal lpGroupInfo 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

SetUrlCacheGroupAttributeW = ctypes.windll.wininet.SetUrlCacheGroupAttributeW
SetUrlCacheGroupAttributeW.restype = wintypes.BOOL
SetUrlCacheGroupAttributeW.argtypes = [
    ctypes.c_longlong,  # gid : LONGLONG
    wintypes.DWORD,  # dwFlags : DWORD optional
    wintypes.DWORD,  # dwAttributes : DWORD
    ctypes.c_void_p,  # lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*
    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')
SetUrlCacheGroupAttributeW = Fiddle::Function.new(
  lib['SetUrlCacheGroupAttributeW'],
  [
    Fiddle::TYPE_LONG_LONG,  # gid : LONGLONG
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
    -Fiddle::TYPE_INT,  # dwAttributes : DWORD
    Fiddle::TYPE_VOIDP,  # lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn SetUrlCacheGroupAttributeW(
        gid: i64,  // LONGLONG
        dwFlags: u32,  // DWORD optional
        dwAttributes: u32,  // DWORD
        lpGroupInfo: *mut INTERNET_CACHE_GROUP_INFOW,  // INTERNET_CACHE_GROUP_INFOW*
        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 SetUrlCacheGroupAttributeW(long gid, uint dwFlags, uint dwAttributes, IntPtr lpGroupInfo, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_SetUrlCacheGroupAttributeW' -Namespace Win32 -PassThru
# $api::SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
#uselib "WININET.dll"
#func global SetUrlCacheGroupAttributeW "SetUrlCacheGroupAttributeW" wptr, wptr, wptr, wptr, wptr
; SetUrlCacheGroupAttributeW gid, dwFlags, dwAttributes, varptr(lpGroupInfo), lpReserved   ; 戻り値は stat
; gid : LONGLONG -> "wptr"
; dwFlags : DWORD optional -> "wptr"
; dwAttributes : DWORD -> "wptr"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> "wptr"
; lpReserved : void* optional -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global SetUrlCacheGroupAttributeW "SetUrlCacheGroupAttributeW" int64, int, int, var, sptr
; res = SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
; gid : LONGLONG -> "int64"
; dwFlags : DWORD optional -> "int"
; dwAttributes : DWORD -> "int"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SetUrlCacheGroupAttributeW(LONGLONG gid, DWORD dwFlags, DWORD dwAttributes, INTERNET_CACHE_GROUP_INFOW* lpGroupInfo, void* lpReserved)
#uselib "WININET.dll"
#cfunc global SetUrlCacheGroupAttributeW "SetUrlCacheGroupAttributeW" int64, int, int, var, intptr
; res = SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
; gid : LONGLONG -> "int64"
; dwFlags : DWORD optional -> "int"
; dwAttributes : DWORD -> "int"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> "var"
; lpReserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procSetUrlCacheGroupAttributeW = wininet.NewProc("SetUrlCacheGroupAttributeW")
)

// gid (LONGLONG), dwFlags (DWORD optional), dwAttributes (DWORD), lpGroupInfo (INTERNET_CACHE_GROUP_INFOW*), lpReserved (void* optional)
r1, _, err := procSetUrlCacheGroupAttributeW.Call(
	uintptr(gid),
	uintptr(dwFlags),
	uintptr(dwAttributes),
	uintptr(lpGroupInfo),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetUrlCacheGroupAttributeW(
  gid: Int64;   // LONGLONG
  dwFlags: DWORD;   // DWORD optional
  dwAttributes: DWORD;   // DWORD
  lpGroupInfo: Pointer;   // INTERNET_CACHE_GROUP_INFOW*
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'WININET.dll' name 'SetUrlCacheGroupAttributeW';
result := DllCall("WININET\SetUrlCacheGroupAttributeW"
    , "Int64", gid   ; LONGLONG
    , "UInt", dwFlags   ; DWORD optional
    , "UInt", dwAttributes   ; DWORD
    , "Ptr", lpGroupInfo   ; INTERNET_CACHE_GROUP_INFOW*
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL
●SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved) = DLL("WININET.dll", "bool SetUrlCacheGroupAttributeW(int64, dword, dword, void*, void*)")
# 呼び出し: SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
# gid : LONGLONG -> "int64"
# dwFlags : DWORD optional -> "dword"
# dwAttributes : DWORD -> "dword"
# lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn SetUrlCacheGroupAttributeW(
    gid: i64, // LONGLONG
    dwFlags: u32, // DWORD optional
    dwAttributes: u32, // DWORD
    lpGroupInfo: [*c]INTERNET_CACHE_GROUP_INFOW, // INTERNET_CACHE_GROUP_INFOW*
    lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetUrlCacheGroupAttributeW(
    gid: int64,  # LONGLONG
    dwFlags: uint32,  # DWORD optional
    dwAttributes: uint32,  # DWORD
    lpGroupInfo: ptr INTERNET_CACHE_GROUP_INFOW,  # INTERNET_CACHE_GROUP_INFOW*
    lpReserved: pointer  # void* optional
): int32 {.importc: "SetUrlCacheGroupAttributeW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int SetUrlCacheGroupAttributeW(
    long gid,   // LONGLONG
    uint dwFlags,   // DWORD optional
    uint dwAttributes,   // DWORD
    INTERNET_CACHE_GROUP_INFOW* lpGroupInfo,   // INTERNET_CACHE_GROUP_INFOW*
    void* lpReserved   // void* optional
);
ccall((:SetUrlCacheGroupAttributeW, "WININET.dll"), stdcall, Int32,
      (Int64, UInt32, UInt32, Ptr{INTERNET_CACHE_GROUP_INFOW}, Ptr{Cvoid}),
      gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
# gid : LONGLONG -> Int64
# dwFlags : DWORD optional -> UInt32
# dwAttributes : DWORD -> UInt32
# lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> Ptr{INTERNET_CACHE_GROUP_INFOW}
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetUrlCacheGroupAttributeW(
    int64_t gid,
    uint32_t dwFlags,
    uint32_t dwAttributes,
    void* lpGroupInfo,
    void* lpReserved);
]]
local wininet = ffi.load("wininet")
-- wininet.SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
-- gid : LONGLONG
-- dwFlags : DWORD optional
-- dwAttributes : DWORD
-- lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const SetUrlCacheGroupAttributeW = lib.func('__stdcall', 'SetUrlCacheGroupAttributeW', 'int32_t', ['int64_t', 'uint32_t', 'uint32_t', 'void *', 'void *']);
// SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
// gid : LONGLONG -> 'int64_t'
// dwFlags : DWORD optional -> 'uint32_t'
// dwAttributes : DWORD -> 'uint32_t'
// lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> 'void *'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  SetUrlCacheGroupAttributeW: { parameters: ["i64", "u32", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved)
// gid : LONGLONG -> "i64"
// dwFlags : DWORD optional -> "u32"
// dwAttributes : DWORD -> "u32"
// lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> "pointer"
// lpReserved : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetUrlCacheGroupAttributeW(
    int64_t gid,
    uint32_t dwFlags,
    uint32_t dwAttributes,
    void* lpGroupInfo,
    void* lpReserved);
C, "WININET.dll");
// $ffi->SetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpReserved);
// gid : LONGLONG
// dwFlags : DWORD optional
// dwAttributes : DWORD
// lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*
// 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.UNICODE_OPTIONS);
    boolean SetUrlCacheGroupAttributeW(
        long gid,   // LONGLONG
        int dwFlags,   // DWORD optional
        int dwAttributes,   // DWORD
        Pointer lpGroupInfo,   // INTERNET_CACHE_GROUP_INFOW*
        Pointer lpReserved   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun SetUrlCacheGroupAttributeW = SetUrlCacheGroupAttributeW(
    gid : Int64,   # LONGLONG
    dwFlags : UInt32,   # DWORD optional
    dwAttributes : UInt32,   # DWORD
    lpGroupInfo : INTERNET_CACHE_GROUP_INFOW*,   # INTERNET_CACHE_GROUP_INFOW*
    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 SetUrlCacheGroupAttributeWNative = Int32 Function(Int64, Uint32, Uint32, Pointer<Void>, Pointer<Void>);
typedef SetUrlCacheGroupAttributeWDart = int Function(int, int, int, Pointer<Void>, Pointer<Void>);
final SetUrlCacheGroupAttributeW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<SetUrlCacheGroupAttributeWNative, SetUrlCacheGroupAttributeWDart>('SetUrlCacheGroupAttributeW');
// gid : LONGLONG -> Int64
// dwFlags : DWORD optional -> Uint32
// dwAttributes : DWORD -> Uint32
// lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> Pointer<Void>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetUrlCacheGroupAttributeW(
  gid: Int64;   // LONGLONG
  dwFlags: DWORD;   // DWORD optional
  dwAttributes: DWORD;   // DWORD
  lpGroupInfo: Pointer;   // INTERNET_CACHE_GROUP_INFOW*
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'WININET.dll' name 'SetUrlCacheGroupAttributeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetUrlCacheGroupAttributeW"
  c_SetUrlCacheGroupAttributeW :: Int64 -> Word32 -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- gid : LONGLONG -> Int64
-- dwFlags : DWORD optional -> Word32
-- dwAttributes : DWORD -> Word32
-- lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> Ptr ()
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let seturlcachegroupattributew =
  foreign "SetUrlCacheGroupAttributeW"
    (int64_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* gid : LONGLONG -> int64_t *)
(* dwFlags : DWORD optional -> uint32_t *)
(* dwAttributes : DWORD -> uint32_t *)
(* lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> (ptr void) *)
(* 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 ("SetUrlCacheGroupAttributeW" set-url-cache-group-attribute-w :convention :stdcall) :int32
  (gid :int64)   ; LONGLONG
  (dw-flags :uint32)   ; DWORD optional
  (dw-attributes :uint32)   ; DWORD
  (lp-group-info :pointer)   ; INTERNET_CACHE_GROUP_INFOW*
  (lp-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetUrlCacheGroupAttributeW = Win32::API::More->new('WININET',
    'BOOL SetUrlCacheGroupAttributeW(INT64 gid, DWORD dwFlags, DWORD dwAttributes, LPVOID lpGroupInfo, LPVOID lpReserved)');
# my $ret = $SetUrlCacheGroupAttributeW->Call($gid, $dwFlags, $dwAttributes, $lpGroupInfo, $lpReserved);
# gid : LONGLONG -> INT64
# dwFlags : DWORD optional -> DWORD
# dwAttributes : DWORD -> DWORD
# lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型