ホーム › Networking.WinInet › InternetGetCookieA

InternetGetCookieA

関数

指定URLに関連付けられたCookieを取得する(ANSI版)。

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

シグネチャ

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

BOOL InternetGetCookieA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPSTR lpszCookieData,   // optional
    DWORD* lpdwSize
);

パラメーター

名前	型	方向	説明
lpszUrl	LPCSTR	in	クッキーを取得する対象の URL を指定する null 終端文字列へのポインターです。
lpszCookieName	LPCSTR	inoptional	実装されていません。
lpszCookieData	LPSTR	outoptional	クッキーデータを受け取るバッファーへのポインターです。このパラメーターには NULL を指定できます。
lpdwSize	DWORD*	inout	lpszCookieData パラメーターのバッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が成功すると、このバッファーには lpszCookieData バッファーへコピーされたデータ量が格納されます。 lpszCookieData が NULL の場合、このパラメーターにはすべてのクッキーデータをコピーするために必要なバッファーのサイズがバイト数で格納されます。

戻り値の型: BOOL

公式ドキュメント

指定した URL のクッキーを取得します。(ANSI)

戻り値

関数が成功すると、TRUE を返します。

関数が失敗すると、FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

以下のエラー値が InternetGetCookie に適用されます。

戻り値	説明
ERROR_NO_MORE_ITEMS	指定した URL とそのすべての親に対するクッキーが存在しません。
ERROR_INSUFFICIENT_BUFFER	lpdwSize に渡された値では、すべてのクッキーデータをコピーするには不十分です。 lpdwSize に返される値は、すべてのデータを取得するために必要なバッファーのサイズです。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。 lpszUrl パラメーターが NULL です。

解説(Remarks)

InternetGetCookie は InternetOpen の呼び出しを必要としません。 InternetGetCookie は、将来のいずれかの時点に有効期限が設定された永続的なクッキーを windows\cookies ディレクトリ内で確認します。 InternetGetCookie は、セッションクッキー、つまり有効期限を持たず同一プロセス内で InternetSetCookie によって作成されたクッキーもメモリ内で検索します。これらのクッキーはどのファイルにも書き込まれないためです。クッキーファイルを作成するための規則はシステム内部のものであり、将来変更される可能性があります。

HTTP Cookies に記載されているとおり、InternetGetCookie は、サーバーが Set-Cookie ヘッダーで "HttpOnly" 属性を使用してスクリプト不可としてマークしたクッキーを返しません。

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

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

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして InternetGetCookie を定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、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 InternetGetCookieA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPSTR lpszCookieData,   // optional
    DWORD* lpdwSize
);

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

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

' lpszUrl : LPCSTR
' lpszCookieName : LPCSTR optional
' lpszCookieData : LPSTR optional, out
' lpdwSize : DWORD* in/out
Declare PtrSafe Function InternetGetCookieA Lib "wininet" ( _
    ByVal lpszUrl As String, _
    ByVal lpszCookieName As String, _
    ByVal lpszCookieData As String, _
    ByRef lpdwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetGetCookieA = ctypes.windll.wininet.InternetGetCookieA
InternetGetCookieA.restype = wintypes.BOOL
InternetGetCookieA.argtypes = [
    wintypes.LPCSTR,  # lpszUrl : LPCSTR
    wintypes.LPCSTR,  # lpszCookieName : LPCSTR optional
    wintypes.LPSTR,  # lpszCookieData : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetGetCookieA = Fiddle::Function.new(
  lib['InternetGetCookieA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetGetCookieA(
        lpszUrl: *const u8,  // LPCSTR
        lpszCookieName: *const u8,  // LPCSTR optional
        lpszCookieData: *mut u8,  // LPSTR optional, out
        lpdwSize: *mut u32  // DWORD* in/out
    ) -> 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 InternetGetCookieA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszCookieData, ref uint lpdwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetCookieA' -Namespace Win32 -PassThru
# $api::InternetGetCookieA(lpszUrl, lpszCookieName, lpszCookieData, lpdwSize)

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

出力引数:

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