ホーム › Networking.WinInet › SetUrlCacheEntryInfoW

SetUrlCacheEntryInfoW

関数

URLキャッシュエントリの情報フィールドを設定する(Unicode版)。

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

シグネチャ

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

BOOL SetUrlCacheEntryInfoW(
    LPCWSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,
    DWORD dwFieldControl
);

パラメーター

名前

型

方向

説明

lpszUrlName

LPCWSTR

キャッシュエントリの名前を指定する null 終端文字列へのポインター。名前の文字列にはエスケープ文字を含めないでください。

lpCacheEntryInfo

INTERNET_CACHE_ENTRY_INFOW*

INTERNET_CACHE_ENTRY_INFO 構造体へのポインター。 lpszUrlName で指定されたキャッシュエントリに割り当てる値を格納します。

dwFieldControl

DWORD

設定するメンバーを示します。このパラメーターには、次の値の組み合わせを指定できます。

値	意味
CACHE_ENTRY_ACCTIME_FC	最終アクセス時刻を設定します。
CACHE_ENTRY_ATTRIBUTE_FC	キャッシュエントリの種類を設定します。
CACHE_ENTRY_EXEMPT_DELTA_FC	除外デルタを設定します。
CACHE_ENTRY_EXPTIME_FC	有効期限を設定します。
CACHE_ENTRY_HEADERINFO_FC	現在は実装されていません。
CACHE_ENTRY_HITRATE_FC	ヒット率を設定します。
CACHE_ENTRY_MODTIME_FC	最終更新時刻を設定します。
CACHE_ENTRY_SYNCTIME_FC	最終同期時刻を設定します。

戻り値の型: BOOL

公式ドキュメント

INTERNET_CACHE_ENTRY_INFO 構造体の指定されたメンバーを設定します。(Unicode)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラー値には次のものがあります。

戻り値	説明
ERROR_FILE_NOT_FOUND	指定されたキャッシュエントリがキャッシュ内に見つかりません。
ERROR_INVALID_PARAMETER	設定しようとした値が無効です。

解説(Remarks)

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

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetUrlCacheEntryInfo を定義します。エンコーディング中立でないコードとエンコーディング中立のエイリアスを混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetUrlCacheEntryInfoW(
    LPCWSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,
    DWORD dwFieldControl
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetUrlCacheEntryInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName,   // LPCWSTR
    IntPtr lpCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOW*
    uint dwFieldControl   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetUrlCacheEntryInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrlName As String,   ' LPCWSTR
    lpCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOW*
    dwFieldControl As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrlName : LPCWSTR
' lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW*
' dwFieldControl : DWORD
Declare PtrSafe Function SetUrlCacheEntryInfoW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr, _
    ByVal lpCacheEntryInfo As LongPtr, _
    ByVal dwFieldControl As Long) 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

SetUrlCacheEntryInfoW = ctypes.windll.wininet.SetUrlCacheEntryInfoW
SetUrlCacheEntryInfoW.restype = wintypes.BOOL
SetUrlCacheEntryInfoW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrlName : LPCWSTR
    ctypes.c_void_p,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW*
    wintypes.DWORD,  # dwFieldControl : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
SetUrlCacheEntryInfoW = Fiddle::Function.new(
  lib['SetUrlCacheEntryInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW*
    -Fiddle::TYPE_INT,  # dwFieldControl : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn SetUrlCacheEntryInfoW(
        lpszUrlName: *const u16,  // LPCWSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOW,  // INTERNET_CACHE_ENTRY_INFOW*
        dwFieldControl: u32  // DWORD
    ) -> 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 SetUrlCacheEntryInfoW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName, IntPtr lpCacheEntryInfo, uint dwFieldControl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_SetUrlCacheEntryInfoW' -Namespace Win32 -PassThru
# $api::SetUrlCacheEntryInfoW(lpszUrlName, lpCacheEntryInfo, dwFieldControl)

#uselib "WININET.dll"
#func global SetUrlCacheEntryInfoW "SetUrlCacheEntryInfoW" wptr, wptr, wptr
; SetUrlCacheEntryInfoW lpszUrlName, varptr(lpCacheEntryInfo), dwFieldControl   ; 戻り値は stat
; lpszUrlName : LPCWSTR -> "wptr"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* -> "wptr"
; dwFieldControl : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global SetUrlCacheEntryInfoW "SetUrlCacheEntryInfoW" wstr, var, int
; res = SetUrlCacheEntryInfoW(lpszUrlName, lpCacheEntryInfo, dwFieldControl)
; lpszUrlName : LPCWSTR -> "wstr"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* -> "var"
; dwFieldControl : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global SetUrlCacheEntryInfoW "SetUrlCacheEntryInfoW" wstr, sptr, int
; res = SetUrlCacheEntryInfoW(lpszUrlName, varptr(lpCacheEntryInfo), dwFieldControl)
; lpszUrlName : LPCWSTR -> "wstr"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* -> "sptr"
; dwFieldControl : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。