InternetGetCookieExW 関数 (wininet.h)
InternetGetCookieEx 関数は、指定した URL に関連付けられている Cookie に格納されているデータを取得します。 InternetGetCookie とは異なり、InternetGetCookieEx を使用すると、信頼されていないサイトまたはサードパーティの Cookie に関連付けられた単一の Cookie 名またはポリシーによって取得されるデータを制限できます。
構文
BOOL InternetGetCookieExW(
[in] LPCWSTR lpszUrl,
[in] LPCWSTR lpszCookieName,
[in, out, optional] LPWSTR lpszCookieData,
[in, out] LPDWORD lpdwSize,
[in] DWORD dwFlags,
[in] LPVOID lpReserved
);
パラメーター
[in] lpszUrl
取得する Cookie が関連付けられている URL を含む null で終わる文字列へのポインター。 このパラメーターを NULL にすることはできません。または InternetGetCookieEx が 失敗し、 ERROR_INVALID_PARAMETER エラーが返されます。
[in] lpszCookieName
取得する Cookie の名前を含む null で終わる文字列へのポインター。 この名前では大文字と小文字が区別されます。
[in, out, optional] lpszCookieData
Cookie データを受信するバッファーへのポインター。
[in, out] lpdwSize
DWORD 変数へのポインター。
入力時に、変数には pchCookieData パラメーターによって指されるバッファーのサイズ (TCHAR) が含まれている必要があります。
終了時に関数が成功した場合、この変数には、バッファーにコピーされた Cookie データの TCHAR の数が含まれます。 null が lpszCookieData パラメーターとして渡された場合、または関数が ERROR_INSUFFICIENT_BUFFER のエラーで失敗した場合、変数には Cookie データを受信するために必要なバッファーのサイズ (BYTE) が含まれます。
このパラメーターを NULL にすることはできません。または InternetGetCookieEx が 失敗し、 ERROR_INVALID_PARAMETER エラーが返されます。
[in] dwFlags
関数が Cookie データを取得する方法を制御するフラグ。 このパラメーターには、次の値のいずれかを指定できます。
[in] lpReserved
将来利用するために予約されています。 NULL に設定します。
戻り値
関数が成功した場合、関数は TRUE を返します。
関数が失敗すると、 FALSE が返されます。 特定のエラー値を取得するには、 GetLastError を呼び出します。
null が lpszCookieData に渡された場合、呼び出しは成功し、関数はERROR_INSUFFICIENT_BUFFER設定されません。
この関数では、次のエラー コードを設定できます。
リターン コード | 説明 |
---|---|
|
取得された Cookie データが pcchCookieData パラメーターが指すバッファー サイズより大きい場合、またはそのパラメーターが NULL の場合に返されます。 |
|
pchURL パラメーターまたは pcchCookieData パラメーターが NULL の場合に返されます。 |
|
指定した Cookie データを取得できなかった場合に返されます。 |
解説
Note
wininet.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして InternetGetCookieEx を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | wininet.h |
Library | Wininet.lib |
[DLL] | Wininet.dll |