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

InternetSetCookieA

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

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetSetCookieA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPCSTR lpszCookieData
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

有効期限なしで InternetSetCookie によって作成された Cookie はメモリに格納され、それを作成したプロセスと同じプロセス内でのみ利用できます。有効期限を含む Cookie は windows\cookies ディレクトリに格納されます。

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

Caution 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 内やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

Note 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  (ANSI / -A)
#include <windows.h>

BOOL InternetSetCookieA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPCSTR lpszCookieData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetSetCookieA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData   // LPCSTR
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetSetCookieA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieData As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrl : LPCSTR
' lpszCookieName : LPCSTR optional
' lpszCookieData : LPCSTR
Declare PtrSafe Function InternetSetCookieA Lib "wininet" ( _
    ByVal lpszUrl As String, _
    ByVal lpszCookieName As String, _
    ByVal lpszCookieData As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('WININET.dll')
InternetSetCookieA = Fiddle::Function.new(
  lib['InternetSetCookieA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn InternetSetCookieA(
        lpszUrl: *const u8,  // LPCSTR
        lpszCookieName: *const u8,  // LPCSTR optional
        lpszCookieData: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool InternetSetCookieA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetCookieA' -Namespace Win32 -PassThru
# $api::InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
#uselib "WININET.dll"
#func global InternetSetCookieA "InternetSetCookieA" sptr, sptr, sptr
; InternetSetCookieA lpszUrl, lpszCookieName, lpszCookieData   ; 戻り値は stat
; lpszUrl : LPCSTR -> "sptr"
; lpszCookieName : LPCSTR optional -> "sptr"
; lpszCookieData : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetSetCookieA "InternetSetCookieA" str, str, str
; res = InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPCSTR -> "str"
; BOOL InternetSetCookieA(LPCSTR lpszUrl, LPCSTR lpszCookieName, LPCSTR lpszCookieData)
#uselib "WININET.dll"
#cfunc global InternetSetCookieA "InternetSetCookieA" str, str, str
; res = InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetCookieA = wininet.NewProc("InternetSetCookieA")
)

// lpszUrl (LPCSTR), lpszCookieName (LPCSTR optional), lpszCookieData (LPCSTR)
r1, _, err := procInternetSetCookieA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszUrl))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszCookieName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszCookieData))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetSetCookieA(
  lpszUrl: PAnsiChar;   // LPCSTR
  lpszCookieName: PAnsiChar;   // LPCSTR optional
  lpszCookieData: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetSetCookieA';
result := DllCall("WININET\InternetSetCookieA"
    , "AStr", lpszUrl   ; LPCSTR
    , "AStr", lpszCookieName   ; LPCSTR optional
    , "AStr", lpszCookieData   ; LPCSTR
    , "Int")   ; return: BOOL
●InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData) = DLL("WININET.dll", "bool InternetSetCookieA(char*, char*, char*)")
# 呼び出し: InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
# lpszUrl : LPCSTR -> "char*"
# lpszCookieName : LPCSTR optional -> "char*"
# lpszCookieData : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn InternetSetCookieA(
    lpszUrl: [*c]const u8, // LPCSTR
    lpszCookieName: [*c]const u8, // LPCSTR optional
    lpszCookieData: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc InternetSetCookieA(
    lpszUrl: cstring,  # LPCSTR
    lpszCookieName: cstring,  # LPCSTR optional
    lpszCookieData: cstring  # LPCSTR
): int32 {.importc: "InternetSetCookieA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int InternetSetCookieA(
    const(char)* lpszUrl,   // LPCSTR
    const(char)* lpszCookieName,   // LPCSTR optional
    const(char)* lpszCookieData   // LPCSTR
);
ccall((:InternetSetCookieA, "WININET.dll"), stdcall, Int32,
      (Cstring, Cstring, Cstring),
      lpszUrl, lpszCookieName, lpszCookieData)
# lpszUrl : LPCSTR -> Cstring
# lpszCookieName : LPCSTR optional -> Cstring
# lpszCookieData : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternetSetCookieA(
    const char* lpszUrl,
    const char* lpszCookieName,
    const char* lpszCookieData);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
-- lpszUrl : LPCSTR
-- lpszCookieName : LPCSTR optional
-- lpszCookieData : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetSetCookieA = lib.func('__stdcall', 'InternetSetCookieA', 'int32_t', ['str', 'str', 'str']);
// InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
// lpszUrl : LPCSTR -> 'str'
// lpszCookieName : LPCSTR optional -> 'str'
// lpszCookieData : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetSetCookieA: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData)
// lpszUrl : LPCSTR -> "buffer"
// lpszCookieName : LPCSTR optional -> "buffer"
// lpszCookieData : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternetSetCookieA(
    const char* lpszUrl,
    const char* lpszCookieName,
    const char* lpszCookieData);
C, "WININET.dll");
// $ffi->InternetSetCookieA(lpszUrl, lpszCookieName, lpszCookieData);
// lpszUrl : LPCSTR
// lpszCookieName : LPCSTR optional
// lpszCookieData : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    boolean InternetSetCookieA(
        String lpszUrl,   // LPCSTR
        String lpszCookieName,   // LPCSTR optional
        String lpszCookieData   // LPCSTR
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetSetCookieA = InternetSetCookieA(
    lpszUrl : UInt8*,   # LPCSTR
    lpszCookieName : UInt8*,   # LPCSTR optional
    lpszCookieData : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("InternetSetCookieA" internet-set-cookie-a :convention :stdcall) :int32
  (lpsz-url :string)   ; LPCSTR
  (lpsz-cookie-name :string)   ; LPCSTR optional
  (lpsz-cookie-data :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetSetCookieA = Win32::API::More->new('WININET',
    'BOOL InternetSetCookieA(LPCSTR lpszUrl, LPCSTR lpszCookieName, LPCSTR lpszCookieData)');
# my $ret = $InternetSetCookieA->Call($lpszUrl, $lpszCookieName, $lpszCookieData);
# lpszUrl : LPCSTR -> LPCSTR
# lpszCookieName : LPCSTR optional -> LPCSTR
# lpszCookieData : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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