Win32 API 日本語リファレンス
ホームNetworking.WinInet › InternetSetCookieEx2

InternetSetCookieEx2

関数
P3Pポリシー付きでCookieを設定し状態を返す。
DLLWININET.dll呼出規約winapi

シグネチャ

// WININET.dll
#include <windows.h>

DWORD InternetSetCookieEx2(
    LPCWSTR pcwszUrl,
    const INTERNET_COOKIE2* pCookie,
    LPCWSTR pcwszP3PPolicy,   // optional
    DWORD dwFlags,
    DWORD* pdwCookieState
);

パラメーター

名前方向説明
pcwszUrlLPCWSTRinCookie を設定する対象の URL。
pCookieINTERNET_COOKIE2*inCookie データを格納した INTERNET_COOKIE2 構造体へのポインター。
pcwszP3PPolicyLPCWSTRinoptionalCookie の Platform-for-Privacy-Protection (P3P) ポリシーを格納した文字列。NULL を指定できます。
dwFlagsDWORDin

設定する Cookie のフラグ。次のフラグを使用できます。

意味
INTERNET_COOKIE_THIRD_PARTY この Cookie をサードパーティのコンテキストで設定します。
INTERNET_COOKIE_PROMPT_REQUIRED ユーザーがこの Cookie を受け入れるか拒否するかを選択する UI プロンプトを表示します。
INTERNET_COOKIE_EVALUATE_P3P この Cookie について、指定された P3P ポリシーを評価します。pcwszP3PPolicy が NULL の場合は既定のポリシーを評価します。
INTERNET_COOKIE_NON_SCRIPT この Cookie が JavaScript 経由で設定されていないことを示し、HTTP 専用 Cookie の設定を許可します。
INTERNET_COOKIE_APPLY_HOST_ONLY この Cookie にホスト専用ポリシーを適用します。domain 属性が設定されていない場合、この Cookie はホスト専用としてマークされます。
pdwCookieStateDWORD*outCookie 設定の結果を受け取る DWORD へのポインター。取り得る値の一覧については、InternetCookieState を参照してください。

戻り値の型: DWORD

公式ドキュメント

指定した URL に関連付けられた Cookie を作成します。(InternetSetCookieEx2)

戻り値

成功した場合は ERROR_SUCCESS を返し、失敗した場合は システムエラーコード を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll
#include <windows.h>

DWORD InternetSetCookieEx2(
    LPCWSTR pcwszUrl,
    const INTERNET_COOKIE2* pCookie,
    LPCWSTR pcwszP3PPolicy,   // optional
    DWORD dwFlags,
    DWORD* pdwCookieState
);
[DllImport("WININET.dll", ExactSpelling = true)]
static extern uint InternetSetCookieEx2(
    [MarshalAs(UnmanagedType.LPWStr)] string pcwszUrl,   // LPCWSTR
    IntPtr pCookie,   // INTERNET_COOKIE2*
    [MarshalAs(UnmanagedType.LPWStr)] string pcwszP3PPolicy,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    out uint pdwCookieState   // DWORD* out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function InternetSetCookieEx2(
    <MarshalAs(UnmanagedType.LPWStr)> pcwszUrl As String,   ' LPCWSTR
    pCookie As IntPtr,   ' INTERNET_COOKIE2*
    <MarshalAs(UnmanagedType.LPWStr)> pcwszP3PPolicy As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pdwCookieState As UInteger   ' DWORD* out
) As UInteger
End Function
' pcwszUrl : LPCWSTR
' pCookie : INTERNET_COOKIE2*
' pcwszP3PPolicy : LPCWSTR optional
' dwFlags : DWORD
' pdwCookieState : DWORD* out
Declare PtrSafe Function InternetSetCookieEx2 Lib "wininet" ( _
    ByVal pcwszUrl As LongPtr, _
    ByVal pCookie As LongPtr, _
    ByVal pcwszP3PPolicy As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef pdwCookieState As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetSetCookieEx2 = ctypes.windll.wininet.InternetSetCookieEx2
InternetSetCookieEx2.restype = wintypes.DWORD
InternetSetCookieEx2.argtypes = [
    wintypes.LPCWSTR,  # pcwszUrl : LPCWSTR
    ctypes.c_void_p,  # pCookie : INTERNET_COOKIE2*
    wintypes.LPCWSTR,  # pcwszP3PPolicy : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwCookieState : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetSetCookieEx2 = Fiddle::Function.new(
  lib['InternetSetCookieEx2'],
  [
    Fiddle::TYPE_VOIDP,  # pcwszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pCookie : INTERNET_COOKIE2*
    Fiddle::TYPE_VOIDP,  # pcwszP3PPolicy : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pdwCookieState : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn InternetSetCookieEx2(
        pcwszUrl: *const u16,  // LPCWSTR
        pCookie: *const INTERNET_COOKIE2,  // INTERNET_COOKIE2*
        pcwszP3PPolicy: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        pdwCookieState: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll")]
public static extern uint InternetSetCookieEx2([MarshalAs(UnmanagedType.LPWStr)] string pcwszUrl, IntPtr pCookie, [MarshalAs(UnmanagedType.LPWStr)] string pcwszP3PPolicy, uint dwFlags, out uint pdwCookieState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetCookieEx2' -Namespace Win32 -PassThru
# $api::InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
#uselib "WININET.dll"
#func global InternetSetCookieEx2 "InternetSetCookieEx2" sptr, sptr, sptr, sptr, sptr
; InternetSetCookieEx2 pcwszUrl, varptr(pCookie), pcwszP3PPolicy, dwFlags, varptr(pdwCookieState)   ; 戻り値は stat
; pcwszUrl : LPCWSTR -> "sptr"
; pCookie : INTERNET_COOKIE2* -> "sptr"
; pcwszP3PPolicy : LPCWSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pdwCookieState : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global InternetSetCookieEx2 "InternetSetCookieEx2" wstr, var, wstr, int, var
; res = InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
; pcwszUrl : LPCWSTR -> "wstr"
; pCookie : INTERNET_COOKIE2* -> "var"
; pcwszP3PPolicy : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pdwCookieState : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD InternetSetCookieEx2(LPCWSTR pcwszUrl, INTERNET_COOKIE2* pCookie, LPCWSTR pcwszP3PPolicy, DWORD dwFlags, DWORD* pdwCookieState)
#uselib "WININET.dll"
#cfunc global InternetSetCookieEx2 "InternetSetCookieEx2" wstr, var, wstr, int, var
; res = InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
; pcwszUrl : LPCWSTR -> "wstr"
; pCookie : INTERNET_COOKIE2* -> "var"
; pcwszP3PPolicy : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pdwCookieState : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetCookieEx2 = wininet.NewProc("InternetSetCookieEx2")
)

// pcwszUrl (LPCWSTR), pCookie (INTERNET_COOKIE2*), pcwszP3PPolicy (LPCWSTR optional), dwFlags (DWORD), pdwCookieState (DWORD* out)
r1, _, err := procInternetSetCookieEx2.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pcwszUrl))),
	uintptr(pCookie),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pcwszP3PPolicy))),
	uintptr(dwFlags),
	uintptr(pdwCookieState),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function InternetSetCookieEx2(
  pcwszUrl: PWideChar;   // LPCWSTR
  pCookie: Pointer;   // INTERNET_COOKIE2*
  pcwszP3PPolicy: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  pdwCookieState: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WININET.dll' name 'InternetSetCookieEx2';
result := DllCall("WININET\InternetSetCookieEx2"
    , "WStr", pcwszUrl   ; LPCWSTR
    , "Ptr", pCookie   ; INTERNET_COOKIE2*
    , "WStr", pcwszP3PPolicy   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pdwCookieState   ; DWORD* out
    , "UInt")   ; return: DWORD
●InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState) = DLL("WININET.dll", "dword InternetSetCookieEx2(char*, void*, char*, dword, void*)")
# 呼び出し: InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
# pcwszUrl : LPCWSTR -> "char*"
# pCookie : INTERNET_COOKIE2* -> "void*"
# pcwszP3PPolicy : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# pdwCookieState : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn InternetSetCookieEx2(
    pcwszUrl: [*c]const u16, // LPCWSTR
    pCookie: [*c]INTERNET_COOKIE2, // INTERNET_COOKIE2*
    pcwszP3PPolicy: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // DWORD
    pdwCookieState: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc InternetSetCookieEx2(
    pcwszUrl: WideCString,  # LPCWSTR
    pCookie: ptr INTERNET_COOKIE2,  # INTERNET_COOKIE2*
    pcwszP3PPolicy: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # DWORD
    pdwCookieState: ptr uint32  # DWORD* out
): uint32 {.importc: "InternetSetCookieEx2", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
uint InternetSetCookieEx2(
    const(wchar)* pcwszUrl,   // LPCWSTR
    INTERNET_COOKIE2* pCookie,   // INTERNET_COOKIE2*
    const(wchar)* pcwszP3PPolicy,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint* pdwCookieState   // DWORD* out
);
ccall((:InternetSetCookieEx2, "WININET.dll"), stdcall, UInt32,
      (Cwstring, Ptr{INTERNET_COOKIE2}, Cwstring, UInt32, Ptr{UInt32}),
      pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
# pcwszUrl : LPCWSTR -> Cwstring
# pCookie : INTERNET_COOKIE2* -> Ptr{INTERNET_COOKIE2}
# pcwszP3PPolicy : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# pdwCookieState : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t InternetSetCookieEx2(
    const uint16_t* pcwszUrl,
    void* pCookie,
    const uint16_t* pcwszP3PPolicy,
    uint32_t dwFlags,
    uint32_t* pdwCookieState);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
-- pcwszUrl : LPCWSTR
-- pCookie : INTERNET_COOKIE2*
-- pcwszP3PPolicy : LPCWSTR optional
-- dwFlags : DWORD
-- pdwCookieState : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetSetCookieEx2 = lib.func('__stdcall', 'InternetSetCookieEx2', 'uint32_t', ['str16', 'void *', 'str16', 'uint32_t', 'uint32_t *']);
// InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
// pcwszUrl : LPCWSTR -> 'str16'
// pCookie : INTERNET_COOKIE2* -> 'void *'
// pcwszP3PPolicy : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// pdwCookieState : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetSetCookieEx2: { parameters: ["buffer", "pointer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState)
// pcwszUrl : LPCWSTR -> "buffer"
// pCookie : INTERNET_COOKIE2* -> "pointer"
// pcwszP3PPolicy : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// pdwCookieState : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t InternetSetCookieEx2(
    const uint16_t* pcwszUrl,
    void* pCookie,
    const uint16_t* pcwszP3PPolicy,
    uint32_t dwFlags,
    uint32_t* pdwCookieState);
C, "WININET.dll");
// $ffi->InternetSetCookieEx2(pcwszUrl, pCookie, pcwszP3PPolicy, dwFlags, pdwCookieState);
// pcwszUrl : LPCWSTR
// pCookie : INTERNET_COOKIE2*
// pcwszP3PPolicy : LPCWSTR optional
// dwFlags : DWORD
// pdwCookieState : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class);
    int InternetSetCookieEx2(
        WString pcwszUrl,   // LPCWSTR
        Pointer pCookie,   // INTERNET_COOKIE2*
        WString pcwszP3PPolicy,   // LPCWSTR optional
        int dwFlags,   // DWORD
        IntByReference pdwCookieState   // DWORD* out
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetSetCookieEx2 = InternetSetCookieEx2(
    pcwszUrl : UInt16*,   # LPCWSTR
    pCookie : INTERNET_COOKIE2*,   # INTERNET_COOKIE2*
    pcwszP3PPolicy : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # DWORD
    pdwCookieState : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetSetCookieEx2Native = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>);
typedef InternetSetCookieEx2Dart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>);
final InternetSetCookieEx2 = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetSetCookieEx2Native, InternetSetCookieEx2Dart>('InternetSetCookieEx2');
// pcwszUrl : LPCWSTR -> Pointer<Utf16>
// pCookie : INTERNET_COOKIE2* -> Pointer<Void>
// pcwszP3PPolicy : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// pdwCookieState : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetSetCookieEx2(
  pcwszUrl: PWideChar;   // LPCWSTR
  pCookie: Pointer;   // INTERNET_COOKIE2*
  pcwszP3PPolicy: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  pdwCookieState: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WININET.dll' name 'InternetSetCookieEx2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetSetCookieEx2"
  c_InternetSetCookieEx2 :: CWString -> Ptr () -> CWString -> Word32 -> Ptr Word32 -> IO Word32
-- pcwszUrl : LPCWSTR -> CWString
-- pCookie : INTERNET_COOKIE2* -> Ptr ()
-- pcwszP3PPolicy : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- pdwCookieState : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetsetcookieex2 =
  foreign "InternetSetCookieEx2"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* pcwszUrl : LPCWSTR -> (ptr uint16_t) *)
(* pCookie : INTERNET_COOKIE2* -> (ptr void) *)
(* pcwszP3PPolicy : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* pdwCookieState : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetSetCookieEx2" internet-set-cookie-ex2 :convention :stdcall) :uint32
  (pcwsz-url (:string :encoding :utf-16le))   ; LPCWSTR
  (p-cookie :pointer)   ; INTERNET_COOKIE2*
  (pcwsz-p3-ppolicy (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; DWORD
  (pdw-cookie-state :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetSetCookieEx2 = Win32::API::More->new('WININET',
    'DWORD InternetSetCookieEx2(LPCWSTR pcwszUrl, LPVOID pCookie, LPCWSTR pcwszP3PPolicy, DWORD dwFlags, LPVOID pdwCookieState)');
# my $ret = $InternetSetCookieEx2->Call($pcwszUrl, $pCookie, $pcwszP3PPolicy, $dwFlags, $pdwCookieState);
# pcwszUrl : LPCWSTR -> LPCWSTR
# pCookie : INTERNET_COOKIE2* -> LPVOID
# pcwszP3PPolicy : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# pdwCookieState : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型