IXMLHTTPRequest2::SetCookie メソッド (msxml6.h)

  • [アーティクル]

HTTP Cookie jar 内の指定された URL に関連付けられている Cookie を設定します。

構文

HRESULT SetCookie(
  const XHR_COOKIE *pCookie,
  DWORD            *pdwCookieState
);

パラメーター

pCookie

指定 した URL に関連付けるクッキーとクッキーのプロパティを指定するXHR_COOKIE構造体へのポインター。

pdwCookieState

呼び出しが正常に完了した場合に Cookie の状態を示す値へのポインター。

このパラメーターには、Msxml6.h ヘッダー ファイルで定義されているXHR_COOKIE_STATE列挙型の値のいずれかを指定できます。

値 意味
XHR_COOKIE_STATE_UNKNOWN
0
 予約済み。
XHR_COOKIE_STATE_ACCEPT
1
 クッキーが受け入れられました。
XHR_COOKIE_STATE_PROMPT
2
 ユーザーはクッキーを受け入れるか拒否するように求められます。
XHR_COOKIE_STATE_LEASH
3
 クッキーはファーストパーティのコンテキストでのみ受け入れられます。
XHR_COOKIE_STATE_DOWNGRADE
4
 クッキーが受け入れられ、セッションクッキーになりました。
XHR_COOKIE_STATE_REJECT
5
 クッキーは拒否されました。

戻り値

成功すると S_OK を返します。

注釈

SetCookie メソッドは、Windows ストア アプリと Windows デスクトップ アプリケーションでは動作が異なります。

Windows ストア アプリで使用する場合、 SetCookie メソッドは 既定で、Windows ストア アプリの永続的な Cookie として Cookie を設定します。 XHR_COOKIEの dwFlags メンバーに XHR_COOKIE_IS_SESSION フラグが設定されている場合、Cookie はアプリの現在のセッションに対してのみ設定されます。

Windows デスクトップ アプリケーションで使用する場合、 SetCookie メソッドは既定でシステム全体で、すべての Windows デスクトップ アプリケーションで共有される永続的な Cookie を設定します。 XHR_COOKIEの dwFlags メンバーに XHR_COOKIE_IS_SESSION フラグが設定されている場合、Cookie は Windows デスクトップ アプリケーションの現在のセッションに対してのみ設定されます。

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリ |UWP アプリ],MSXML 6.0 以降
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー msxml6.h

こちらもご覧ください

GetCookie メソッド

IXMLHTTPRequest2

XHR_COOKIE構造体

XHR_COOKIE_STATE