ホーム › Networking.WinInet › InternetGetCookieExA

InternetGetCookieExA

関数

フラグ指定で拡張的にCookieを取得する(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL InternetGetCookieExA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPSTR lpszCookieData,   // optional
    DWORD* lpdwSize,
    INTERNET_COOKIE_FLAGS dwFlags,
    void* lpReserved   // optional
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCSTR

取得対象の Cookie が関連付けられている URL を含む null 終端文字列へのポインターです。このパラメーターを NULL にすることはできません。NULL の場合、InternetGetCookieEx は失敗し、ERROR_INVALID_PARAMETER エラーを返します。

lpszCookieName

LPCSTR

inoptional

取得する Cookie の名前を含む null 終端文字列へのポインターです。この名前は大文字と小文字を区別します。

lpszCookieData

LPSTR

inoptional

Cookie データを受け取るバッファーへのポインターです。

lpdwSize

DWORD*

inout

DWORD 変数へのポインターです。

呼び出し時には、この変数に pchCookieData パラメーターが指すバッファーのサイズ(TCHAR 単位)を格納しておく必要があります。

終了時、関数が成功した場合、この変数にはバッファーへコピーされた Cookie データの TCHAR 数が格納されます。lpszCookieData パラメーターに NULL を渡した場合、または関数が ERROR_INSUFFICIENT_BUFFER エラーで失敗した場合、この変数には Cookie データの受け取りに必要なバッファーのサイズ(BYTE 単位)が格納されます。

このパラメーターを NULL にすることはできません。NULL の場合、InternetGetCookieEx は失敗し、ERROR_INVALID_PARAMETER エラーを返します。

dwFlags

INTERNET_COOKIE_FLAGS

関数が Cookie データを取得する方法を制御するフラグです。このパラメーターには次のいずれかの値を指定できます。

Value

Meaning

INTERNET_COOKIE_HTTPONLY

"HTTPOnly" としてマークされた Cookie の取得を有効にします。

スクリプト可能なインターフェイスを公開する場合は、セキュリティ上の影響があるため、このフラグを使用しないでください。提供する拡張機能を通じてサードパーティのコードに Cookie を決して公開しないことを保証できる場合に限り、このフラグを使用することが極めて重要です。

Version: Internet Explorer 8.0 以降が必要です。

INTERNET_COOKIE_THIRD_PARTY

指定した URL のすべての Cookie の取得をポリシーが明示的に許可している場合に限り、サードパーティの Cookie のみを取得します。

INTERNET_FLAG_RESTRICTED_ZONE

指定した URL が信頼されていない場合、すなわち URLZONE_UNTRUSTED ゾーンに属している場合に許可される Cookie のみを取得します。

lpReserved

void*

optional

将来の使用のために予約されています。NULL を設定してください。

戻り値の型: BOOL

公式ドキュメント

指定した URL に関連付けられた Cookie に格納されているデータを取得します。(ANSI)

戻り値

関数が成功した場合は TRUE を返します。

関数が失敗した場合は FALSE を返します。具体的なエラー値を取得するには、 GetLastError を呼び出します。

lpszCookieData に NULL を渡した場合、呼び出しは成功し、関数は ERROR_INSUFFICIENT_BUFFER を設定しません。

この関数は次のエラーコードを設定することがあります。

Return code	Description
ERROR_INSUFFICIENT_BUFFER	取得した Cookie データが pcchCookieData パラメーターが指すバッファーサイズより大きい場合、またはそのパラメーターが NULL の場合に返されます。
ERROR_INVALID_PARAMETER	pchURL または pcchCookieData パラメーターのいずれかが NULL の場合に返されます。
ERROR_NO_MORE_ITEMS	指定された Cookie データを取得できなかった場合に返されます。

解説(Remarks)

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

メモ

wininet.h ヘッダーは、InternetGetCookieEx を、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  (ANSI / -A)
#include <windows.h>

BOOL InternetGetCookieExA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPSTR lpszCookieData,   // optional
    DWORD* lpdwSize,
    INTERNET_COOKIE_FLAGS dwFlags,
    void* lpReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetGetCookieExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData,   // LPSTR optional
    ref uint lpdwSize,   // DWORD* in/out
    uint dwFlags,   // INTERNET_COOKIE_FLAGS
    IntPtr lpReserved   // void* optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetGetCookieExA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieData As String,   ' LPSTR optional
    ByRef lpdwSize As UInteger,   ' DWORD* in/out
    dwFlags As UInteger,   ' INTERNET_COOKIE_FLAGS
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrl : LPCSTR
' lpszCookieName : LPCSTR optional
' lpszCookieData : LPSTR optional
' lpdwSize : DWORD* in/out
' dwFlags : INTERNET_COOKIE_FLAGS
' lpReserved : void* optional
Declare PtrSafe Function InternetGetCookieExA Lib "wininet" ( _
    ByVal lpszUrl As String, _
    ByVal lpszCookieName As String, _
    ByVal lpszCookieData As String, _
    ByRef lpdwSize As Long, _
    ByVal dwFlags 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

InternetGetCookieExA = ctypes.windll.wininet.InternetGetCookieExA
InternetGetCookieExA.restype = wintypes.BOOL
InternetGetCookieExA.argtypes = [
    wintypes.LPCSTR,  # lpszUrl : LPCSTR
    wintypes.LPCSTR,  # lpszCookieName : LPCSTR optional
    wintypes.LPCSTR,  # lpszCookieData : LPSTR optional
    ctypes.POINTER(wintypes.DWORD),  # lpdwSize : DWORD* in/out
    wintypes.DWORD,  # dwFlags : INTERNET_COOKIE_FLAGS
    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')
InternetGetCookieExA = Fiddle::Function.new(
  lib['InternetGetCookieExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpdwSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : INTERNET_COOKIE_FLAGS
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetGetCookieExA(
        lpszUrl: *const u8,  // LPCSTR
        lpszCookieName: *const u8,  // LPCSTR optional
        lpszCookieData: *mut u8,  // LPSTR optional
        lpdwSize: *mut u32,  // DWORD* in/out
        dwFlags: u32,  // INTERNET_COOKIE_FLAGS
        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, SetLastError = true)]
public static extern bool InternetGetCookieExA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData, ref uint lpdwSize, uint dwFlags, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetCookieExA' -Namespace Win32 -PassThru
# $api::InternetGetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, lpdwSize, dwFlags, lpReserved)

#uselib "WININET.dll"
#func global InternetGetCookieExA "InternetGetCookieExA" sptr, sptr, sptr, sptr, sptr, sptr
; InternetGetCookieExA lpszUrl, lpszCookieName, lpszCookieData, varptr(lpdwSize), dwFlags, lpReserved   ; 戻り値は stat
; lpszUrl : LPCSTR -> "sptr"
; lpszCookieName : LPCSTR optional -> "sptr"
; lpszCookieData : LPSTR optional -> "sptr"
; lpdwSize : DWORD* in/out -> "sptr"
; dwFlags : INTERNET_COOKIE_FLAGS -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetGetCookieExA "InternetGetCookieExA" str, str, str, var, int, sptr
; res = InternetGetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, lpdwSize, dwFlags, lpReserved)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPSTR optional -> "str"
; lpdwSize : DWORD* in/out -> "var"
; dwFlags : INTERNET_COOKIE_FLAGS -> "int"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetGetCookieExA "InternetGetCookieExA" str, str, str, sptr, int, sptr
; res = InternetGetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, varptr(lpdwSize), dwFlags, lpReserved)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPSTR optional -> "str"
; lpdwSize : DWORD* in/out -> "sptr"
; dwFlags : INTERNET_COOKIE_FLAGS -> "int"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。