ホーム › Networking.WinInet › GetUrlCacheGroupAttributeW

GetUrlCacheGroupAttributeW

関数

URLキャッシュグループの属性情報を取得する(Unicode版)。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

gid

LONGLONG

キャッシュグループの識別子。

dwFlags

DWORD

optional

このパラメーターは予約されており、0 を指定する必要があります。

dwAttributes

DWORD

取得する属性。次のいずれかの値を指定できます。

値	意味
CACHEGROUP_ATTRIBUTE_BASIC	キャッシュグループのフラグ、種類、ディスククォータの属性を取得します。
CACHEGROUP_ATTRIBUTE_FLAG	キャッシュグループに関連付けられたフラグを設定または取得します。
CACHEGROUP_ATTRIBUTE_GET_ALL	キャッシュグループのすべての属性を取得します。
CACHEGROUP_ATTRIBUTE_GROUPNAME	キャッシュグループのグループ名を設定または取得します。
CACHEGROUP_ATTRIBUTE_QUOTA	キャッシュグループに関連付けられたディスククォータを設定または取得します。
CACHEGROUP_ATTRIBUTE_STORAGE	キャッシュグループに関連付けられたグループ所有者ストレージを設定または取得します。
CACHEGROUP_ATTRIBUTE_TYPE	キャッシュグループの種類を設定または取得します。

lpGroupInfo

INTERNET_CACHE_GROUP_INFOW*

out

要求された情報を受け取る INTERNET_CACHE_GROUP_INFO 構造体へのポインター。

lpcbGroupInfo

DWORD*

inout

lpGroupInfo バッファーのサイズを格納する変数へのポインター。関数が戻ると、この変数にはバッファーにコピーされたバイト数、または必要なバッファーのサイズ(バイト単位)が格納されます。

lpReserved

void*

optional

このパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

メモ

wininet.h ヘッダーは GetUrlCacheGroupAttribute をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、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 GetUrlCacheGroupAttributeW(
    LONGLONG gid,
    DWORD dwFlags,   // optional
    DWORD dwAttributes,
    INTERNET_CACHE_GROUP_INFOW* lpGroupInfo,
    DWORD* lpcbGroupInfo,
    void* lpReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUrlCacheGroupAttributeW(
    long gid,   // LONGLONG
    uint dwFlags,   // DWORD optional
    uint dwAttributes,   // DWORD
    IntPtr lpGroupInfo,   // INTERNET_CACHE_GROUP_INFOW* out
    ref uint lpcbGroupInfo,   // DWORD* in/out
    IntPtr lpReserved   // void* optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUrlCacheGroupAttributeW(
    gid As Long,   ' LONGLONG
    dwFlags As UInteger,   ' DWORD optional
    dwAttributes As UInteger,   ' DWORD
    lpGroupInfo As IntPtr,   ' INTERNET_CACHE_GROUP_INFOW* out
    ByRef lpcbGroupInfo As UInteger,   ' DWORD* in/out
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' gid : LONGLONG
' dwFlags : DWORD optional
' dwAttributes : DWORD
' lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* out
' lpcbGroupInfo : DWORD* in/out
' lpReserved : void* optional
Declare PtrSafe Function GetUrlCacheGroupAttributeW Lib "wininet" ( _
    ByVal gid As LongLong, _
    ByVal dwFlags As Long, _
    ByVal dwAttributes As Long, _
    ByVal lpGroupInfo As LongPtr, _
    ByRef lpcbGroupInfo As Long, _
    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

GetUrlCacheGroupAttributeW = ctypes.windll.wininet.GetUrlCacheGroupAttributeW
GetUrlCacheGroupAttributeW.restype = wintypes.BOOL
GetUrlCacheGroupAttributeW.argtypes = [
    ctypes.c_longlong,  # gid : LONGLONG
    wintypes.DWORD,  # dwFlags : DWORD optional
    wintypes.DWORD,  # dwAttributes : DWORD
    ctypes.c_void_p,  # lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* out
    ctypes.POINTER(wintypes.DWORD),  # lpcbGroupInfo : DWORD* in/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')
GetUrlCacheGroupAttributeW = Fiddle::Function.new(
  lib['GetUrlCacheGroupAttributeW'],
  [
    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* out
    Fiddle::TYPE_VOIDP,  # lpcbGroupInfo : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheGroupAttributeW(
        gid: i64,  // LONGLONG
        dwFlags: u32,  // DWORD optional
        dwAttributes: u32,  // DWORD
        lpGroupInfo: *mut INTERNET_CACHE_GROUP_INFOW,  // INTERNET_CACHE_GROUP_INFOW* out
        lpcbGroupInfo: *mut u32,  // DWORD* in/out
        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 GetUrlCacheGroupAttributeW(long gid, uint dwFlags, uint dwAttributes, IntPtr lpGroupInfo, ref uint lpcbGroupInfo, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheGroupAttributeW' -Namespace Win32 -PassThru
# $api::GetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpcbGroupInfo, lpReserved)

#uselib "WININET.dll"
#func global GetUrlCacheGroupAttributeW "GetUrlCacheGroupAttributeW" wptr, wptr, wptr, wptr, wptr, wptr
; GetUrlCacheGroupAttributeW gid, dwFlags, dwAttributes, varptr(lpGroupInfo), varptr(lpcbGroupInfo), lpReserved   ; 戻り値は stat
; gid : LONGLONG -> "wptr"
; dwFlags : DWORD optional -> "wptr"
; dwAttributes : DWORD -> "wptr"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* out -> "wptr"
; lpcbGroupInfo : DWORD* in/out -> "wptr"
; lpReserved : void* optional -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global GetUrlCacheGroupAttributeW "GetUrlCacheGroupAttributeW" int64, int, int, var, var, sptr
; res = GetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, lpGroupInfo, lpcbGroupInfo, lpReserved)
; gid : LONGLONG -> "int64"
; dwFlags : DWORD optional -> "int"
; dwAttributes : DWORD -> "int"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* out -> "var"
; lpcbGroupInfo : DWORD* in/out -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "WININET.dll"
#cfunc global GetUrlCacheGroupAttributeW "GetUrlCacheGroupAttributeW" int64, int, int, sptr, sptr, sptr
; res = GetUrlCacheGroupAttributeW(gid, dwFlags, dwAttributes, varptr(lpGroupInfo), varptr(lpcbGroupInfo), lpReserved)
; gid : LONGLONG -> "int64"
; dwFlags : DWORD optional -> "int"
; dwAttributes : DWORD -> "int"
; lpGroupInfo : INTERNET_CACHE_GROUP_INFOW* out -> "sptr"
; lpcbGroupInfo : DWORD* in/out -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。