ホーム › Networking.WinInet › InternetGetPerSiteCookieDecisionA

InternetGetPerSiteCookieDecisionA

関数

サイト別のCookie許可設定を取得する(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetGetPerSiteCookieDecisionA(
    LPCSTR pchHostName,
    DWORD* pResult
);

パラメーター

名前	型	方向	説明
pchHostName	LPCSTR	in	ドメインを含む文字列を指す LPCTSTR です。
pResult	DWORD*	out	InternetCookieState 列挙値のいずれかを格納する unsigned long へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定したドメインに対する Cookie の判定を取得します。(ANSI)

戻り値

判定を取得できた場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

戻り値が FALSE の場合、ドメイン pchHostName にサイト固有の Cookie 規定が存在しないことを示している可能性があります。

WinINet は pchHostName パラメーターで指定されたドメインを最小化し、最小の有効なドメインに対して Cookie ポリシーを設定します。たとえば、指定したホスト名が widgets.microsoft.com の場合、ポリシーは最小化されたホスト名 microsoft.com に設定されます。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 InternetGetPerSiteCookieDecisionA(
    LPCSTR pchHostName,
    DWORD* pResult
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool InternetGetPerSiteCookieDecisionA(
    [MarshalAs(UnmanagedType.LPStr)] string pchHostName,   // LPCSTR
    out uint pResult   // DWORD* out
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function InternetGetPerSiteCookieDecisionA(
    <MarshalAs(UnmanagedType.LPStr)> pchHostName As String,   ' LPCSTR
    <Out> ByRef pResult As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pchHostName : LPCSTR
' pResult : DWORD* out
Declare PtrSafe Function InternetGetPerSiteCookieDecisionA Lib "wininet" ( _
    ByVal pchHostName As String, _
    ByRef pResult As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetGetPerSiteCookieDecisionA = ctypes.windll.wininet.InternetGetPerSiteCookieDecisionA
InternetGetPerSiteCookieDecisionA.restype = wintypes.BOOL
InternetGetPerSiteCookieDecisionA.argtypes = [
    wintypes.LPCSTR,  # pchHostName : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pResult : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetGetPerSiteCookieDecisionA = Fiddle::Function.new(
  lib['InternetGetPerSiteCookieDecisionA'],
  [
    Fiddle::TYPE_VOIDP,  # pchHostName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pResult : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetGetPerSiteCookieDecisionA(
        pchHostName: *const u8,  // LPCSTR
        pResult: *mut u32  // DWORD* out
    ) -> 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 InternetGetPerSiteCookieDecisionA([MarshalAs(UnmanagedType.LPStr)] string pchHostName, out uint pResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetPerSiteCookieDecisionA' -Namespace Win32 -PassThru
# $api::InternetGetPerSiteCookieDecisionA(pchHostName, pResult)

#uselib "WININET.dll"
#func global InternetGetPerSiteCookieDecisionA "InternetGetPerSiteCookieDecisionA" sptr, sptr
; InternetGetPerSiteCookieDecisionA pchHostName, varptr(pResult)   ; 戻り値は stat
; pchHostName : LPCSTR -> "sptr"
; pResult : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetGetPerSiteCookieDecisionA "InternetGetPerSiteCookieDecisionA" str, var
; res = InternetGetPerSiteCookieDecisionA(pchHostName, pResult)
; pchHostName : LPCSTR -> "str"
; pResult : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetGetPerSiteCookieDecisionA "InternetGetPerSiteCookieDecisionA" str, sptr
; res = InternetGetPerSiteCookieDecisionA(pchHostName, varptr(pResult))
; pchHostName : LPCSTR -> "str"
; pResult : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。