ホーム › Networking.WinInet › InternetGetCookieW

InternetGetCookieW

関数

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

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

シグネチャ

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

BOOL InternetGetCookieW(
    LPCWSTR lpszUrl,
    LPCWSTR lpszCookieName,   // optional
    LPWSTR lpszCookieData,   // optional
    DWORD* lpdwSize
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

指定された URL に対応する Cookie を取得します。(Unicode)

戻り値

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

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

InternetGetCookie には次のエラー値が適用されます。

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

解説(Remarks)

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

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

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  (Unicode / -W)
#include <windows.h>

BOOL InternetGetCookieW(
    LPCWSTR lpszUrl,
    LPCWSTR lpszCookieName,   // optional
    LPWSTR lpszCookieData,   // optional
    DWORD* lpdwSize
);

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

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

' lpszUrl : LPCWSTR
' lpszCookieName : LPCWSTR optional
' lpszCookieData : LPWSTR optional, out
' lpdwSize : DWORD* in/out
Declare PtrSafe Function InternetGetCookieW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal lpszCookieName As LongPtr, _
    ByVal lpszCookieData As LongPtr, _
    ByRef lpdwSize 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

InternetGetCookieW = ctypes.windll.wininet.InternetGetCookieW
InternetGetCookieW.restype = wintypes.BOOL
InternetGetCookieW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    wintypes.LPCWSTR,  # lpszCookieName : LPCWSTR optional
    wintypes.LPWSTR,  # lpszCookieData : LPWSTR 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')
InternetGetCookieW = Fiddle::Function.new(
  lib['InternetGetCookieW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpdwSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn InternetGetCookieW(
        lpszUrl: *const u16,  // LPCWSTR
        lpszCookieName: *const u16,  // LPCWSTR optional
        lpszCookieData: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool InternetGetCookieW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPWStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszCookieData, ref uint lpdwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetCookieW' -Namespace Win32 -PassThru
# $api::InternetGetCookieW(lpszUrl, lpszCookieName, lpszCookieData, lpdwSize)

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

出力引数:

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