InternetGetCookieExA 函式 (wininet.h)

發行項
03/13/2024

InternetGetCookieEx 函式會擷取儲存在與指定 URL 相關聯的 Cookie 中的數據。不同於 InternetGetCookie，InternetGetCookieEx 可用來限制擷取至單一 Cookie 名稱的數據，或依據原則，與不受信任的網站或第三方 Cookie 相關聯。

語法

BOOL InternetGetCookieExA(
  [in]                LPCSTR  lpszUrl,
  [in]                LPCSTR  lpszCookieName,
  [in, out, optional] LPSTR   lpszCookieData,
  [in, out]           LPDWORD lpdwSize,
  [in]                DWORD   dwFlags,
  [in]                LPVOID  lpReserved
);

參數

[in] lpszUrl

Null 終止字串的指標，其中包含要擷取之 Cookie 相關聯的 URL。此參數不可為 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 數據所需的緩衝區大小。

此參數不可為 NULL 或 InternetGetCookieEx 失敗，並傳回 ERROR_INVALID_PARAMETER 錯誤。

[in] dwFlags

旗標，控制函式如何擷取Cookie數據。此參數可以是下列其中一個值。

值	意義
INTERNET_COOKIE_HTTPONLY	啟用擷取標示為「HTTPOnly」的 Cookie。如果您公開可編寫腳本的介面，請勿使用此旗標，因為這具有安全性影響。只有當您可以透過您提供的擴充性機制，保證永遠不會向第三方程式代碼公開 Cookie 時，才使用這個旗標。版本：需要 Internet Explorer 8.0 或更新版本。
INTERNET_COOKIE_THIRD_PARTY	如果原則明確允許擷取指定 URL 的所有 Cookie，則只擷取第三方 Cookie。
INTERNET_FLAG_RESTRICTED_ZONE	只擷取指定 URL 不受信任時允許的 Cookie;也就是說，如果屬於URLZONE_UNTRUSTED區域，

值

意義

INTERNET_COOKIE_HTTPONLY

啟用擷取標示為「HTTPOnly」的 Cookie。

如果您公開可編寫腳本的介面，請勿使用此旗標，因為這具有安全性影響。只有當您可以透過您提供的擴充性機制，保證永遠不會向第三方程式代碼公開 Cookie 時，才使用這個旗標。

版本： 需要 Internet Explorer 8.0 或更新版本。

INTERNET_COOKIE_THIRD_PARTY

如果原則明確允許擷取指定 URL 的所有 Cookie，則只擷取第三方 Cookie。

INTERNET_FLAG_RESTRICTED_ZONE

只擷取指定 URL 不受信任時允許的 Cookie;也就是說，如果屬於URLZONE_UNTRUSTED區域，

[in] lpReserved

保留供未來使用。設定為 NULL。

傳回值

如果函式成功，函式會傳回 TRUE。

如果函式失敗，則會傳回 FALSE。若要取得特定的錯誤值，請呼叫 GetLastError。

如果 NULL 傳遞至 lpszCookieData，則呼叫將會成功，且函式不會設定 ERROR_INSUFFICIENT_BUFFER。

下列錯誤碼可由此函式設定。

傳回碼	Description
ERROR_INSUFFICIENT_BUFFER	如果擷取的 Cookie 資料大於 pcchCookieData 參數所指向的緩衝區大小，或該參數為 NULL，則傳回。
ERROR_INVALID_PARAMETER	如果 pchURL 或 pcchCookieData 參數為 NULL，則會傳回。
ERROR_NO_MORE_ITEMS	如果無法擷取指定的 Cookied 資料，則傳回。

備註

注意 WinINet 不支援伺服器實作。此外，它不應該從服務使用。對於伺服器實作或服務，請使用 Microsoft Windows HTTP 服務 (WinHTTP) 。

注意

wininet.h 標頭會將 InternetGetCookieEx 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	wininet.h
程式庫	Wininet.lib
Dll	Wininet.dll