ホーム › Networking.WinInet › InternetSetCookieExA

InternetSetCookieExA

関数

フラグ指定で拡張的にCookieを設定する(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD InternetSetCookieExA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPCSTR lpszCookieData,
    DWORD dwFlags,
    UINT_PTR dwReserved   // optional
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCSTR

Cookie を設定する対象の URL を含む null 終端文字列へのポインターです。

このポインターが NULL の場合、InternetSetCookieEx は ERROR_INVALID_PARAMETER エラーで失敗します。

lpszCookieName

LPCSTR

inoptional

この Cookie に関連付ける名前を含む null 終端文字列へのポインターです。このポインターが NULL の場合、Cookie には名前が関連付けられません。

lpszCookieData

LPCSTR

新しい Cookie に関連付けるデータを含む null 終端文字列へのポインターです。

このポインターが NULL の場合、InternetSetCookieEx は ERROR_INVALID_PARAMETER エラーで失敗します。

dwFlags

DWORD

関数が Cookie データを取得する方法を制御するフラグです。

値	意味
INTERNET_COOKIE_EVALUATE_P3P	このフラグが設定されており、かつ dwReserved パラメーターが NULL でない場合、dwReserved パラメーターは、対象の Cookie の Platform-for-Privacy-Protection (P3P) ヘッダーを指す LPCTSTR としてキャストされます。
INTERNET_COOKIE_HTTPONLY	"HTTPOnly" としてマークされた Cookie の取得を有効にします。スクリプト可能なインターフェイスを公開する場合は、このフラグを使用しないでください。セキュリティ上の問題があるためです。スクリプト可能なインターフェイスを公開すると、クロスサイトスクリプティング攻撃の攻撃経路になる可能性があります。提供する拡張機構を通じてサードパーティのコードがこのフラグを使って Cookie を設定することを決して許さないと保証できる場合に限り、このフラグを使用することがきわめて重要です。バージョン: Internet Explorer 8.0 以降が必要です。
INTERNET_COOKIE_THIRD_PARTY	設定する Cookie がサードパーティ Cookie であることを示します。
INTERNET_FLAG_RESTRICTED_ZONE	設定する Cookie が信頼されていないサイトに関連付けられていることを示します。

dwReserved

UINT_PTR

inoptional

NULL、または Cookie に関連付ける Platform-for-Privacy-Protection (P3P) ヘッダーへのポインターを含みます。

戻り値の型: DWORD

公式ドキュメント

InternetSetCookieEx 関数は、指定した URL に関連付けられた、指定した名前の Cookie を作成します。この関数は、サードパーティ Cookie を作成できる点で InternetSetCookie 関数と異なります。(ANSI)

戻り値

成功した場合は InternetCookieState 列挙型のメンバーを返し、関数が失敗した場合は FALSE を返します。失敗時に GetLastError の呼び出しが ERROR_NOT_ENOUGH_MEMORY を返した場合、システムメモリが不足していたことを示します。

解説(Remarks)

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

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして InternetSetCookieEx を定義します。エンコード非依存のエイリアスの使用を、エンコード非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD InternetSetCookieExA(
    LPCSTR lpszUrl,
    LPCSTR lpszCookieName,   // optional
    LPCSTR lpszCookieData,
    DWORD dwFlags,
    UINT_PTR dwReserved   // optional
);

[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint InternetSetCookieExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData,   // LPCSTR
    uint dwFlags,   // DWORD
    UIntPtr dwReserved   // UINT_PTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetSetCookieExA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpszCookieData As String,   ' LPCSTR
    dwFlags As UInteger,   ' DWORD
    dwReserved As UIntPtr   ' UINT_PTR optional
) As UInteger
End Function

' lpszUrl : LPCSTR
' lpszCookieName : LPCSTR optional
' lpszCookieData : LPCSTR
' dwFlags : DWORD
' dwReserved : UINT_PTR optional
Declare PtrSafe Function InternetSetCookieExA Lib "wininet" ( _
    ByVal lpszUrl As String, _
    ByVal lpszCookieName As String, _
    ByVal lpszCookieData As String, _
    ByVal dwFlags As Long, _
    ByVal dwReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetSetCookieExA = ctypes.windll.wininet.InternetSetCookieExA
InternetSetCookieExA.restype = wintypes.DWORD
InternetSetCookieExA.argtypes = [
    wintypes.LPCSTR,  # lpszUrl : LPCSTR
    wintypes.LPCSTR,  # lpszCookieName : LPCSTR optional
    wintypes.LPCSTR,  # lpszCookieData : LPCSTR
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwReserved : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetSetCookieExA = Fiddle::Function.new(
  lib['InternetSetCookieExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszCookieName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpszCookieData : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwReserved : UINT_PTR optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetSetCookieExA(
        lpszUrl: *const u8,  // LPCSTR
        lpszCookieName: *const u8,  // LPCSTR optional
        lpszCookieData: *const u8,  // LPCSTR
        dwFlags: u32,  // DWORD
        dwReserved: usize  // UINT_PTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint InternetSetCookieExA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieName, [MarshalAs(UnmanagedType.LPStr)] string lpszCookieData, uint dwFlags, UIntPtr dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetCookieExA' -Namespace Win32 -PassThru
# $api::InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)

#uselib "WININET.dll"
#func global InternetSetCookieExA "InternetSetCookieExA" sptr, sptr, sptr, sptr, sptr
; InternetSetCookieExA lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved   ; 戻り値は stat
; lpszUrl : LPCSTR -> "sptr"
; lpszCookieName : LPCSTR optional -> "sptr"
; lpszCookieData : LPCSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwReserved : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "WININET.dll"
#cfunc global InternetSetCookieExA "InternetSetCookieExA" str, str, str, int, sptr
; res = InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; dwReserved : UINT_PTR optional -> "sptr"

; DWORD InternetSetCookieExA(LPCSTR lpszUrl, LPCSTR lpszCookieName, LPCSTR lpszCookieData, DWORD dwFlags, UINT_PTR dwReserved)
#uselib "WININET.dll"
#cfunc global InternetSetCookieExA "InternetSetCookieExA" str, str, str, int, intptr
; res = InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
; lpszUrl : LPCSTR -> "str"
; lpszCookieName : LPCSTR optional -> "str"
; lpszCookieData : LPCSTR -> "str"
; dwFlags : DWORD -> "int"
; dwReserved : UINT_PTR optional -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetCookieExA = wininet.NewProc("InternetSetCookieExA")
)

// lpszUrl (LPCSTR), lpszCookieName (LPCSTR optional), lpszCookieData (LPCSTR), dwFlags (DWORD), dwReserved (UINT_PTR optional)
r1, _, err := procInternetSetCookieExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszUrl))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszCookieName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszCookieData))),
	uintptr(dwFlags),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function InternetSetCookieExA(
  lpszUrl: PAnsiChar;   // LPCSTR
  lpszCookieName: PAnsiChar;   // LPCSTR optional
  lpszCookieData: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  dwReserved: NativeUInt   // UINT_PTR optional
): DWORD; stdcall;
  external 'WININET.dll' name 'InternetSetCookieExA';

result := DllCall("WININET\InternetSetCookieExA"
    , "AStr", lpszUrl   ; LPCSTR
    , "AStr", lpszCookieName   ; LPCSTR optional
    , "AStr", lpszCookieData   ; LPCSTR
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwReserved   ; UINT_PTR optional
    , "UInt")   ; return: DWORD

●InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved) = DLL("WININET.dll", "dword InternetSetCookieExA(char*, char*, char*, dword, int)")
# 呼び出し: InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
# lpszUrl : LPCSTR -> "char*"
# lpszCookieName : LPCSTR optional -> "char*"
# lpszCookieData : LPCSTR -> "char*"
# dwFlags : DWORD -> "dword"
# dwReserved : UINT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "wininet" fn InternetSetCookieExA(
    lpszUrl: [*c]const u8, // LPCSTR
    lpszCookieName: [*c]const u8, // LPCSTR optional
    lpszCookieData: [*c]const u8, // LPCSTR
    dwFlags: u32, // DWORD
    dwReserved: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) u32;

proc InternetSetCookieExA(
    lpszUrl: cstring,  # LPCSTR
    lpszCookieName: cstring,  # LPCSTR optional
    lpszCookieData: cstring,  # LPCSTR
    dwFlags: uint32,  # DWORD
    dwReserved: uint  # UINT_PTR optional
): uint32 {.importc: "InternetSetCookieExA", stdcall, dynlib: "WININET.dll".}

pragma(lib, "wininet");
extern(Windows)
uint InternetSetCookieExA(
    const(char)* lpszUrl,   // LPCSTR
    const(char)* lpszCookieName,   // LPCSTR optional
    const(char)* lpszCookieData,   // LPCSTR
    uint dwFlags,   // DWORD
    size_t dwReserved   // UINT_PTR optional
);

ccall((:InternetSetCookieExA, "WININET.dll"), stdcall, UInt32,
      (Cstring, Cstring, Cstring, UInt32, Csize_t),
      lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
# lpszUrl : LPCSTR -> Cstring
# lpszCookieName : LPCSTR optional -> Cstring
# lpszCookieData : LPCSTR -> Cstring
# dwFlags : DWORD -> UInt32
# dwReserved : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t InternetSetCookieExA(
    const char* lpszUrl,
    const char* lpszCookieName,
    const char* lpszCookieData,
    uint32_t dwFlags,
    uintptr_t dwReserved);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
-- lpszUrl : LPCSTR
-- lpszCookieName : LPCSTR optional
-- lpszCookieData : LPCSTR
-- dwFlags : DWORD
-- dwReserved : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetSetCookieExA = lib.func('__stdcall', 'InternetSetCookieExA', 'uint32_t', ['str', 'str', 'str', 'uint32_t', 'uintptr_t']);
// InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
// lpszUrl : LPCSTR -> 'str'
// lpszCookieName : LPCSTR optional -> 'str'
// lpszCookieData : LPCSTR -> 'str'
// dwFlags : DWORD -> 'uint32_t'
// dwReserved : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("WININET.dll", {
  InternetSetCookieExA: { parameters: ["buffer", "buffer", "buffer", "u32", "usize"], result: "u32" },
});
// lib.symbols.InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved)
// lpszUrl : LPCSTR -> "buffer"
// lpszCookieName : LPCSTR optional -> "buffer"
// lpszCookieData : LPCSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// dwReserved : UINT_PTR optional -> "usize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t InternetSetCookieExA(
    const char* lpszUrl,
    const char* lpszCookieName,
    const char* lpszCookieData,
    uint32_t dwFlags,
    size_t dwReserved);
C, "WININET.dll");
// $ffi->InternetSetCookieExA(lpszUrl, lpszCookieName, lpszCookieData, dwFlags, dwReserved);
// lpszUrl : LPCSTR
// lpszCookieName : LPCSTR optional
// lpszCookieData : LPCSTR
// dwFlags : DWORD
// dwReserved : UINT_PTR optional
// 構造体/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);
    int InternetSetCookieExA(
        String lpszUrl,   // LPCSTR
        String lpszCookieName,   // LPCSTR optional
        String lpszCookieData,   // LPCSTR
        int dwFlags,   // DWORD
        long dwReserved   // UINT_PTR optional
    );
}

@[Link("wininet")]
lib LibWININET
  fun InternetSetCookieExA = InternetSetCookieExA(
    lpszUrl : UInt8*,   # LPCSTR
    lpszCookieName : UInt8*,   # LPCSTR optional
    lpszCookieData : UInt8*,   # LPCSTR
    dwFlags : UInt32,   # DWORD
    dwReserved : LibC::SizeT   # UINT_PTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetSetCookieExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, UintPtr);
typedef InternetSetCookieExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, int);
final InternetSetCookieExA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetSetCookieExANative, InternetSetCookieExADart>('InternetSetCookieExA');
// lpszUrl : LPCSTR -> Pointer<Utf8>
// lpszCookieName : LPCSTR optional -> Pointer<Utf8>
// lpszCookieData : LPCSTR -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// dwReserved : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function InternetSetCookieExA(
  lpszUrl: PAnsiChar;   // LPCSTR
  lpszCookieName: PAnsiChar;   // LPCSTR optional
  lpszCookieData: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // DWORD
  dwReserved: NativeUInt   // UINT_PTR optional
): DWORD; stdcall;
  external 'WININET.dll' name 'InternetSetCookieExA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetSetCookieExA"
  c_InternetSetCookieExA :: CString -> CString -> CString -> Word32 -> CUIntPtr -> IO Word32
-- lpszUrl : LPCSTR -> CString
-- lpszCookieName : LPCSTR optional -> CString
-- lpszCookieData : LPCSTR -> CString
-- dwFlags : DWORD -> Word32
-- dwReserved : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let internetsetcookieexa =
  foreign "InternetSetCookieExA"
    (string @-> string @-> string @-> uint32_t @-> size_t @-> returning uint32_t)
(* lpszUrl : LPCSTR -> string *)
(* lpszCookieName : LPCSTR optional -> string *)
(* lpszCookieData : LPCSTR -> string *)
(* dwFlags : DWORD -> uint32_t *)
(* dwReserved : UINT_PTR optional -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetSetCookieExA" internet-set-cookie-ex-a :convention :stdcall) :uint32
  (lpsz-url :string)   ; LPCSTR
  (lpsz-cookie-name :string)   ; LPCSTR optional
  (lpsz-cookie-data :string)   ; LPCSTR
  (dw-flags :uint32)   ; DWORD
  (dw-reserved :uint64))   ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $InternetSetCookieExA = Win32::API::More->new('WININET',
    'DWORD InternetSetCookieExA(LPCSTR lpszUrl, LPCSTR lpszCookieName, LPCSTR lpszCookieData, DWORD dwFlags, WPARAM dwReserved)');
# my $ret = $InternetSetCookieExA->Call($lpszUrl, $lpszCookieName, $lpszCookieData, $dwFlags, $dwReserved);
# lpszUrl : LPCSTR -> LPCSTR
# lpszCookieName : LPCSTR optional -> LPCSTR
# lpszCookieData : LPCSTR -> LPCSTR
# dwFlags : DWORD -> DWORD
# dwReserved : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

InternetSetCookieExA

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目