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

InternetSetCookieW

関数
指定URLにCookieを設定して保存する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL InternetSetCookieW(
    LPCWSTR lpszUrl,
    LPCWSTR lpszCookieName,   // optional
    LPCWSTR lpszCookieData
);

パラメーター

名前型方向説明
lpszUrlLPCWSTRinCookie を設定する対象の URL を指定する null 終端文字列へのポインターです。
lpszCookieNameLPCWSTRinoptionalCookie データに関連付ける名前を指定する null 終端文字列へのポインターです。このパラメーターが NULL の場合、Cookie に名前は関連付けられません。
lpszCookieDataLPCWSTRinURL に関連付ける実際のデータへのポインターです。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

成功した場合は TRUE、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。

解説(Remarks)

有効期限を指定せずに InternetSetCookie で作成された Cookie はメモリに保存され、それを作成したプロセス内でのみ利用できます。有効期限を含む Cookie は windows\cookies ディレクトリに保存されます。

新しい Cookie を作成すると、ユーザーのプライバシー設定に基づいて、このサイトからの Cookie を許可するか拒否するかをユーザーに尋ねるダイアログボックスが画面に表示されることがあります。

注意 InternetSetCookie は、Internet Explorer で「すべての Cookie をブロックする」が設定されている場合でも、無条件に Cookie を作成します。この動作は、たとえそのような Cookie が「すべての Cookie をブロックする」設定が有効な間はサーバーに送り返されないとしても、プライバシーの侵害とみなされることがあります。アプリケーションは、ユーザーのプライバシー設定を正しく尊重するために InternetSetCookieEx を使用してください。

Cookie の内部動作の詳細については、http://blogs.msdn.com/ieinternals/archive/2009/08/20/WinINET-IE-Cookie-Internals-FAQ.aspx を参照してください。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内や、グローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスからも使用すべきではありません。サーバー実装やサービスでは Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは InternetSetCookie を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、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 InternetSetCookieW(
    LPCWSTR lpszUrl,
    LPCWSTR lpszCookieName,   // optional
    LPCWSTR lpszCookieData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InternetSetCookieW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrl,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszCookieName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpszCookieData   // LPCWSTR
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetSetCookieW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrl As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszCookieName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszCookieData As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrl : LPCWSTR
' lpszCookieName : LPCWSTR optional
' lpszCookieData : LPCWSTR
Declare PtrSafe Function InternetSetCookieW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal lpszCookieName As LongPtr, _
    ByVal lpszCookieData As LongPtr) 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

InternetSetCookieW = ctypes.windll.wininet.InternetSetCookieW
InternetSetCookieW.restype = wintypes.BOOL
InternetSetCookieW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    wintypes.LPCWSTR,  # lpszCookieName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpszCookieData : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetSetCookieW = Fiddle::Function.new(
  lib['InternetSetCookieW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn InternetSetCookieW(
        lpszUrl: *const u16,  // LPCWSTR
        lpszCookieName: *const u16,  // LPCWSTR optional
        lpszCookieData: *const u16  // LPCWSTR
    ) -> 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 InternetSetCookieW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPWStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPWStr)] string lpszCookieData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetCookieW' -Namespace Win32 -PassThru
# $api::InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
#uselib "WININET.dll"
#func global InternetSetCookieW "InternetSetCookieW" wptr, wptr, wptr
; InternetSetCookieW lpszUrl, lpszCookieName, lpszCookieData   ; 戻り値は stat
; lpszUrl : LPCWSTR -> "wptr"
; lpszCookieName : LPCWSTR optional -> "wptr"
; lpszCookieData : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetSetCookieW "InternetSetCookieW" wstr, wstr, wstr
; res = InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
; lpszUrl : LPCWSTR -> "wstr"
; lpszCookieName : LPCWSTR optional -> "wstr"
; lpszCookieData : LPCWSTR -> "wstr"
; BOOL InternetSetCookieW(LPCWSTR lpszUrl, LPCWSTR lpszCookieName, LPCWSTR lpszCookieData)
#uselib "WININET.dll"
#cfunc global InternetSetCookieW "InternetSetCookieW" wstr, wstr, wstr
; res = InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
; lpszUrl : LPCWSTR -> "wstr"
; lpszCookieName : LPCWSTR optional -> "wstr"
; lpszCookieData : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetCookieW = wininet.NewProc("InternetSetCookieW")
)

// lpszUrl (LPCWSTR), lpszCookieName (LPCWSTR optional), lpszCookieData (LPCWSTR)
r1, _, err := procInternetSetCookieW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszUrl))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszCookieName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszCookieData))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetSetCookieW(
  lpszUrl: PWideChar;   // LPCWSTR
  lpszCookieName: PWideChar;   // LPCWSTR optional
  lpszCookieData: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetSetCookieW';
result := DllCall("WININET\InternetSetCookieW"
    , "WStr", lpszUrl   ; LPCWSTR
    , "WStr", lpszCookieName   ; LPCWSTR optional
    , "WStr", lpszCookieData   ; LPCWSTR
    , "Int")   ; return: BOOL
●InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData) = DLL("WININET.dll", "bool InternetSetCookieW(char*, char*, char*)")
# 呼び出し: InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
# lpszUrl : LPCWSTR -> "char*"
# lpszCookieName : LPCWSTR optional -> "char*"
# lpszCookieData : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn InternetSetCookieW(
    lpszUrl: [*c]const u16, // LPCWSTR
    lpszCookieName: [*c]const u16, // LPCWSTR optional
    lpszCookieData: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc InternetSetCookieW(
    lpszUrl: WideCString,  # LPCWSTR
    lpszCookieName: WideCString,  # LPCWSTR optional
    lpszCookieData: WideCString  # LPCWSTR
): int32 {.importc: "InternetSetCookieW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int InternetSetCookieW(
    const(wchar)* lpszUrl,   // LPCWSTR
    const(wchar)* lpszCookieName,   // LPCWSTR optional
    const(wchar)* lpszCookieData   // LPCWSTR
);
ccall((:InternetSetCookieW, "WININET.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring),
      lpszUrl, lpszCookieName, lpszCookieData)
# lpszUrl : LPCWSTR -> Cwstring
# lpszCookieName : LPCWSTR optional -> Cwstring
# lpszCookieData : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternetSetCookieW(
    const uint16_t* lpszUrl,
    const uint16_t* lpszCookieName,
    const uint16_t* lpszCookieData);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
-- lpszUrl : LPCWSTR
-- lpszCookieName : LPCWSTR optional
-- lpszCookieData : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetSetCookieW = lib.func('__stdcall', 'InternetSetCookieW', 'int32_t', ['str16', 'str16', 'str16']);
// InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
// lpszUrl : LPCWSTR -> 'str16'
// lpszCookieName : LPCWSTR optional -> 'str16'
// lpszCookieData : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetSetCookieW: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData)
// lpszUrl : LPCWSTR -> "buffer"
// lpszCookieName : LPCWSTR optional -> "buffer"
// lpszCookieData : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternetSetCookieW(
    const uint16_t* lpszUrl,
    const uint16_t* lpszCookieName,
    const uint16_t* lpszCookieData);
C, "WININET.dll");
// $ffi->InternetSetCookieW(lpszUrl, lpszCookieName, lpszCookieData);
// lpszUrl : LPCWSTR
// lpszCookieName : LPCWSTR optional
// lpszCookieData : LPCWSTR
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    boolean InternetSetCookieW(
        WString lpszUrl,   // LPCWSTR
        WString lpszCookieName,   // LPCWSTR optional
        WString lpszCookieData   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun InternetSetCookieW = InternetSetCookieW(
    lpszUrl : UInt16*,   # LPCWSTR
    lpszCookieName : UInt16*,   # LPCWSTR optional
    lpszCookieData : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetSetCookieWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
typedef InternetSetCookieWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
final InternetSetCookieW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetSetCookieWNative, InternetSetCookieWDart>('InternetSetCookieW');
// lpszUrl : LPCWSTR -> Pointer<Utf16>
// lpszCookieName : LPCWSTR optional -> Pointer<Utf16>
// lpszCookieData : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetSetCookieW(
  lpszUrl: PWideChar;   // LPCWSTR
  lpszCookieName: PWideChar;   // LPCWSTR optional
  lpszCookieData: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetSetCookieW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetSetCookieW"
  c_InternetSetCookieW :: CWString -> CWString -> CWString -> IO CInt
-- lpszUrl : LPCWSTR -> CWString
-- lpszCookieName : LPCWSTR optional -> CWString
-- lpszCookieData : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetsetcookiew =
  foreign "InternetSetCookieW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpszUrl : LPCWSTR -> (ptr uint16_t) *)
(* lpszCookieName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpszCookieData : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetSetCookieW" internet-set-cookie-w :convention :stdcall) :int32
  (lpsz-url (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-cookie-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lpsz-cookie-data (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetSetCookieW = Win32::API::More->new('WININET',
    'BOOL InternetSetCookieW(LPCWSTR lpszUrl, LPCWSTR lpszCookieName, LPCWSTR lpszCookieData)');
# my $ret = $InternetSetCookieW->Call($lpszUrl, $lpszCookieName, $lpszCookieData);
# lpszUrl : LPCWSTR -> LPCWSTR
# lpszCookieName : LPCWSTR optional -> LPCWSTR
# lpszCookieData : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目