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

HttpPushEnable

関数
HTTPサーバープッシュ機能を有効化する。
DLLWININET.dll呼出規約winapi

シグネチャ

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

DWORD HttpPushEnable(
    void* hRequest,
    HTTP_PUSH_TRANSPORT_SETTING* pTransportSetting,
    HTTP_PUSH_WAIT_HANDLE* phWait
);

パラメーター

名前方向説明
hRequestvoid*inサーバープッシュを有効化する対象のHTTP要求ハンドル。
pTransportSettingHTTP_PUSH_TRANSPORT_SETTING*inプッシュ用トランスポート設定を保持するHTTP_PUSH_TRANSPORT_SETTING構造体へのポインター。
phWaitHTTP_PUSH_WAIT_HANDLE*outプッシュ通知待機に使うHTTP_PUSH_WAIT_HANDLEを受け取るポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD HttpPushEnable(
    void* hRequest,
    HTTP_PUSH_TRANSPORT_SETTING* pTransportSetting,
    HTTP_PUSH_WAIT_HANDLE* phWait
);
[DllImport("WININET.dll", ExactSpelling = true)]
static extern uint HttpPushEnable(
    IntPtr hRequest,   // void*
    IntPtr pTransportSetting,   // HTTP_PUSH_TRANSPORT_SETTING*
    IntPtr phWait   // HTTP_PUSH_WAIT_HANDLE* out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function HttpPushEnable(
    hRequest As IntPtr,   ' void*
    pTransportSetting As IntPtr,   ' HTTP_PUSH_TRANSPORT_SETTING*
    phWait As IntPtr   ' HTTP_PUSH_WAIT_HANDLE* out
) As UInteger
End Function
' hRequest : void*
' pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*
' phWait : HTTP_PUSH_WAIT_HANDLE* out
Declare PtrSafe Function HttpPushEnable Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal pTransportSetting As LongPtr, _
    ByVal phWait As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpPushEnable = ctypes.windll.wininet.HttpPushEnable
HttpPushEnable.restype = wintypes.DWORD
HttpPushEnable.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    ctypes.c_void_p,  # pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*
    ctypes.c_void_p,  # phWait : HTTP_PUSH_WAIT_HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
HttpPushEnable = Fiddle::Function.new(
  lib['HttpPushEnable'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*
    Fiddle::TYPE_VOIDP,  # phWait : HTTP_PUSH_WAIT_HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn HttpPushEnable(
        hRequest: *mut (),  // void*
        pTransportSetting: *mut HTTP_PUSH_TRANSPORT_SETTING,  // HTTP_PUSH_TRANSPORT_SETTING*
        phWait: *mut *mut core::ffi::c_void  // HTTP_PUSH_WAIT_HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll")]
public static extern uint HttpPushEnable(IntPtr hRequest, IntPtr pTransportSetting, IntPtr phWait);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpPushEnable' -Namespace Win32 -PassThru
# $api::HttpPushEnable(hRequest, pTransportSetting, phWait)
#uselib "WININET.dll"
#func global HttpPushEnable "HttpPushEnable" sptr, sptr, sptr
; HttpPushEnable hRequest, varptr(pTransportSetting), phWait   ; 戻り値は stat
; hRequest : void* -> "sptr"
; pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> "sptr"
; phWait : HTTP_PUSH_WAIT_HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global HttpPushEnable "HttpPushEnable" sptr, var, sptr
; res = HttpPushEnable(hRequest, pTransportSetting, phWait)
; hRequest : void* -> "sptr"
; pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> "var"
; phWait : HTTP_PUSH_WAIT_HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD HttpPushEnable(void* hRequest, HTTP_PUSH_TRANSPORT_SETTING* pTransportSetting, HTTP_PUSH_WAIT_HANDLE* phWait)
#uselib "WININET.dll"
#cfunc global HttpPushEnable "HttpPushEnable" intptr, var, intptr
; res = HttpPushEnable(hRequest, pTransportSetting, phWait)
; hRequest : void* -> "intptr"
; pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> "var"
; phWait : HTTP_PUSH_WAIT_HANDLE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpPushEnable = wininet.NewProc("HttpPushEnable")
)

// hRequest (void*), pTransportSetting (HTTP_PUSH_TRANSPORT_SETTING*), phWait (HTTP_PUSH_WAIT_HANDLE* out)
r1, _, err := procHttpPushEnable.Call(
	uintptr(hRequest),
	uintptr(pTransportSetting),
	uintptr(phWait),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpPushEnable(
  hRequest: Pointer;   // void*
  pTransportSetting: Pointer;   // HTTP_PUSH_TRANSPORT_SETTING*
  phWait: Pointer   // HTTP_PUSH_WAIT_HANDLE* out
): DWORD; stdcall;
  external 'WININET.dll' name 'HttpPushEnable';
result := DllCall("WININET\HttpPushEnable"
    , "Ptr", hRequest   ; void*
    , "Ptr", pTransportSetting   ; HTTP_PUSH_TRANSPORT_SETTING*
    , "Ptr", phWait   ; HTTP_PUSH_WAIT_HANDLE* out
    , "UInt")   ; return: DWORD
●HttpPushEnable(hRequest, pTransportSetting, phWait) = DLL("WININET.dll", "dword HttpPushEnable(void*, void*, void*)")
# 呼び出し: HttpPushEnable(hRequest, pTransportSetting, phWait)
# hRequest : void* -> "void*"
# pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> "void*"
# phWait : HTTP_PUSH_WAIT_HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn HttpPushEnable(
    hRequest: ?*anyopaque, // void*
    pTransportSetting: [*c]HTTP_PUSH_TRANSPORT_SETTING, // HTTP_PUSH_TRANSPORT_SETTING*
    phWait: ?*anyopaque // HTTP_PUSH_WAIT_HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc HttpPushEnable(
    hRequest: pointer,  # void*
    pTransportSetting: ptr HTTP_PUSH_TRANSPORT_SETTING,  # HTTP_PUSH_TRANSPORT_SETTING*
    phWait: pointer  # HTTP_PUSH_WAIT_HANDLE* out
): uint32 {.importc: "HttpPushEnable", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
uint HttpPushEnable(
    void* hRequest,   // void*
    HTTP_PUSH_TRANSPORT_SETTING* pTransportSetting,   // HTTP_PUSH_TRANSPORT_SETTING*
    void* phWait   // HTTP_PUSH_WAIT_HANDLE* out
);
ccall((:HttpPushEnable, "WININET.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{HTTP_PUSH_TRANSPORT_SETTING}, Ptr{Cvoid}),
      hRequest, pTransportSetting, phWait)
# hRequest : void* -> Ptr{Cvoid}
# pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> Ptr{HTTP_PUSH_TRANSPORT_SETTING}
# phWait : HTTP_PUSH_WAIT_HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpPushEnable(
    void* hRequest,
    void* pTransportSetting,
    void* phWait);
]]
local wininet = ffi.load("wininet")
-- wininet.HttpPushEnable(hRequest, pTransportSetting, phWait)
-- hRequest : void*
-- pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*
-- phWait : HTTP_PUSH_WAIT_HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const HttpPushEnable = lib.func('__stdcall', 'HttpPushEnable', 'uint32_t', ['void *', 'void *', 'void *']);
// HttpPushEnable(hRequest, pTransportSetting, phWait)
// hRequest : void* -> 'void *'
// pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> 'void *'
// phWait : HTTP_PUSH_WAIT_HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  HttpPushEnable: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.HttpPushEnable(hRequest, pTransportSetting, phWait)
// hRequest : void* -> "pointer"
// pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> "pointer"
// phWait : HTTP_PUSH_WAIT_HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpPushEnable(
    void* hRequest,
    void* pTransportSetting,
    void* phWait);
C, "WININET.dll");
// $ffi->HttpPushEnable(hRequest, pTransportSetting, phWait);
// hRequest : void*
// pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*
// phWait : HTTP_PUSH_WAIT_HANDLE* 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 HttpPushEnable(
        Pointer hRequest,   // void*
        Pointer pTransportSetting,   // HTTP_PUSH_TRANSPORT_SETTING*
        Pointer phWait   // HTTP_PUSH_WAIT_HANDLE* out
    );
}
@[Link("wininet")]
lib LibWININET
  fun HttpPushEnable = HttpPushEnable(
    hRequest : Void*,   # void*
    pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING*,   # HTTP_PUSH_TRANSPORT_SETTING*
    phWait : Void*   # HTTP_PUSH_WAIT_HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpPushEnableNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef HttpPushEnableDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final HttpPushEnable = DynamicLibrary.open('WININET.dll')
    .lookupFunction<HttpPushEnableNative, HttpPushEnableDart>('HttpPushEnable');
// hRequest : void* -> Pointer<Void>
// pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> Pointer<Void>
// phWait : HTTP_PUSH_WAIT_HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpPushEnable(
  hRequest: Pointer;   // void*
  pTransportSetting: Pointer;   // HTTP_PUSH_TRANSPORT_SETTING*
  phWait: Pointer   // HTTP_PUSH_WAIT_HANDLE* out
): DWORD; stdcall;
  external 'WININET.dll' name 'HttpPushEnable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpPushEnable"
  c_HttpPushEnable :: Ptr () -> Ptr () -> Ptr () -> IO Word32
-- hRequest : void* -> Ptr ()
-- pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> Ptr ()
-- phWait : HTTP_PUSH_WAIT_HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httppushenable =
  foreign "HttpPushEnable"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hRequest : void* -> (ptr void) *)
(* pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> (ptr void) *)
(* phWait : HTTP_PUSH_WAIT_HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("HttpPushEnable" http-push-enable :convention :stdcall) :uint32
  (h-request :pointer)   ; void*
  (p-transport-setting :pointer)   ; HTTP_PUSH_TRANSPORT_SETTING*
  (ph-wait :pointer))   ; HTTP_PUSH_WAIT_HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpPushEnable = Win32::API::More->new('WININET',
    'DWORD HttpPushEnable(LPVOID hRequest, LPVOID pTransportSetting, HANDLE phWait)');
# my $ret = $HttpPushEnable->Call($hRequest, $pTransportSetting, $phWait);
# hRequest : void* -> LPVOID
# pTransportSetting : HTTP_PUSH_TRANSPORT_SETTING* -> LPVOID
# phWait : HTTP_PUSH_WAIT_HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型