WinHttpSetStatusCallback
関数シグネチャ
// WINHTTP.dll
#include <windows.h>
WINHTTP_STATUS_CALLBACK WinHttpSetStatusCallback(
void* hInternet,
WINHTTP_STATUS_CALLBACK lpfnInternetCallback,
DWORD dwNotificationFlags,
UINT_PTR dwReserved
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hInternet | void* | inout | コールバックを設定する対象の HINTERNET ハンドル。 | ||||||||||||||||||||||||||||||||||||||
| lpfnInternetCallback | WINHTTP_STATUS_CALLBACK | in | 進行があったときに呼び出すコールバック関数へのポインター。既存のコールバック関数を削除するには、これを NULL に設定します。コールバック関数の詳細については、 WINHTTP_STATUS_CALLBACK を参照してください。 | ||||||||||||||||||||||||||||||||||||||
| dwNotificationFlags | DWORD | in | どのイベントでコールバック関数を起動するかを示すフラグを指定する unsigned long 整数値。 指定できる値は次のとおりです。
| ||||||||||||||||||||||||||||||||||||||
| dwReserved | UINT_PTR | in | このパラメーターは予約されており、NULL でなければなりません。 |
戻り値の型: WINHTTP_STATUS_CALLBACK
公式ドキュメント
WinHttpSetStatusCallback 関数は、操作の進行に応じて WinHTTP が呼び出すことのできるコールバック関数を設定します。
戻り値
成功した場合は、以前に定義されたステータスコールバック関数へのポインターを返します。以前に定義されたステータスコールバック関数がなかった場合は NULL を返します。コールバック関数をインストールできなかった場合は WINHTTP_INVALID_STATUS_CALLBACK を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。
| エラーコード | 説明 |
|---|---|
| 指定されたハンドルの種類が、この操作に対して正しくありません。 | |
| 内部エラーが発生しました。 | |
| 要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード) |
解説(Remarks)
リクエストハンドルを作成する前にセッションハンドルにコールバックを設定した場合、リクエストハンドルは親セッションからコールバック関数ポインターを継承します。
WinHTTP が非同期モードで使用されている場合 (つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合) であっても、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。
同期関数と非同期関数のどちらも、名前解決やサーバーへの接続などのリクエストの進行状況を示すためにコールバック関数を使用します。非同期操作にはコールバック関数が必須です。
コールバック関数は任意のハンドルに設定でき、派生ハンドルに継承されます。前のコールバック値を使用する必要がある保留中のリクエストがない限り、 WinHttpSetStatusCallback を使用してコールバック関数を変更できます。ただし、あるハンドルでコールバック関数を変更しても、 WinHttpConnect が返すような派生ハンドルのコールバックは変更されません。各レベルでコールバック関数を変更する必要があります。
多くの WinHTTP 関数は、ネットワーク上で複数の操作を実行します。各操作には完了までに時間がかかる場合があり、それぞれが失敗する可能性もあります。
WinHttpSetStatusCallback 関数を呼び出した後、時間のかかるネットワーク操作を監視するために、WinHTTP 内部からコールバック関数にアクセスできます。
非同期処理の最後に、アプリケーションはコールバック関数を NULL に設定できます。これにより、クライアントアプリケーションが追加の通知を受け取らないようにできます。
次のコードスニペットは、コールバック関数を NULL に設定する推奨方法を示しています。
WinHttpSetStatusCallback( hOpen,
NULL,
WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS,
NULL );
ただし、WinHTTP は WinHttpSetStatusCallback をワーカースレッドと同期しないことに注意してください。アプリケーションが WinHttpSetStatusCallback を呼び出したときに、別のスレッドで開始されたコールバックが進行中だった場合、WinHttpSetStatusCallback がコールバック関数を NULL に正常に設定して戻った後でも、アプリケーションはコールバック通知を受け取ります。
例
次の例は、非同期 WinHTTP 関数用のコールバック関数をインストールする方法を示しています。この例では、"AsyncCallback( )" という名前の WINHTTP_STATUS_CALLBACK 関数が既に実装されていることを前提としています。
// Use WinHttpOpen to obtain an HINTERNET handle.
HINTERNET hSession = WinHttpOpen(L"A WinHTTP Example Program/1.0",
WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
WINHTTP_NO_PROXY_NAME,
WINHTTP_NO_PROXY_BYPASS, 0);
if (hSession)
{
// Install the status callback function.
WINHTTP_STATUS_CALLBACK isCallback = WinHttpSetStatusCallback( hSession,
(WINHTTP_STATUS_CALLBACK)AsyncCallback,
WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS,
NULL);
// Place additional code here.
// When finished, release the HINTERNET handle.
WinHttpCloseHandle(hSession);
}
else
{
printf("Error %u in WinHttpOpen.\n", GetLastError());
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WINHTTP.dll
#include <windows.h>
WINHTTP_STATUS_CALLBACK WinHttpSetStatusCallback(
void* hInternet,
WINHTTP_STATUS_CALLBACK lpfnInternetCallback,
DWORD dwNotificationFlags,
UINT_PTR dwReserved
);[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WinHttpSetStatusCallback(
IntPtr hInternet, // void* in/out
IntPtr lpfnInternetCallback, // WINHTTP_STATUS_CALLBACK
uint dwNotificationFlags, // DWORD
UIntPtr dwReserved // UINT_PTR
);<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpSetStatusCallback(
hInternet As IntPtr, ' void* in/out
lpfnInternetCallback As IntPtr, ' WINHTTP_STATUS_CALLBACK
dwNotificationFlags As UInteger, ' DWORD
dwReserved As UIntPtr ' UINT_PTR
) As IntPtr
End Function' hInternet : void* in/out
' lpfnInternetCallback : WINHTTP_STATUS_CALLBACK
' dwNotificationFlags : DWORD
' dwReserved : UINT_PTR
Declare PtrSafe Function WinHttpSetStatusCallback Lib "winhttp" ( _
ByVal hInternet As LongPtr, _
ByVal lpfnInternetCallback As LongPtr, _
ByVal dwNotificationFlags As Long, _
ByVal dwReserved As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WinHttpSetStatusCallback = ctypes.windll.winhttp.WinHttpSetStatusCallback
WinHttpSetStatusCallback.restype = ctypes.c_void_p
WinHttpSetStatusCallback.argtypes = [
ctypes.POINTER(None), # hInternet : void* in/out
ctypes.c_void_p, # lpfnInternetCallback : WINHTTP_STATUS_CALLBACK
wintypes.DWORD, # dwNotificationFlags : DWORD
ctypes.c_size_t, # dwReserved : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpSetStatusCallback = Fiddle::Function.new(
lib['WinHttpSetStatusCallback'],
[
Fiddle::TYPE_VOIDP, # hInternet : void* in/out
Fiddle::TYPE_VOIDP, # lpfnInternetCallback : WINHTTP_STATUS_CALLBACK
-Fiddle::TYPE_INT, # dwNotificationFlags : DWORD
Fiddle::TYPE_UINTPTR_T, # dwReserved : UINT_PTR
],
Fiddle::TYPE_VOIDP)#[link(name = "winhttp")]
extern "system" {
fn WinHttpSetStatusCallback(
hInternet: *mut (), // void* in/out
lpfnInternetCallback: *const core::ffi::c_void, // WINHTTP_STATUS_CALLBACK
dwNotificationFlags: u32, // DWORD
dwReserved: usize // UINT_PTR
) -> *const core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern IntPtr WinHttpSetStatusCallback(IntPtr hInternet, IntPtr lpfnInternetCallback, uint dwNotificationFlags, UIntPtr dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpSetStatusCallback' -Namespace Win32 -PassThru
# $api::WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)#uselib "WINHTTP.dll"
#func global WinHttpSetStatusCallback "WinHttpSetStatusCallback" sptr, sptr, sptr, sptr
; WinHttpSetStatusCallback hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved ; 戻り値は stat
; hInternet : void* in/out -> "sptr"
; lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> "sptr"
; dwNotificationFlags : DWORD -> "sptr"
; dwReserved : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WINHTTP.dll"
#cfunc global WinHttpSetStatusCallback "WinHttpSetStatusCallback" sptr, sptr, int, sptr
; res = WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
; hInternet : void* in/out -> "sptr"
; lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> "sptr"
; dwNotificationFlags : DWORD -> "int"
; dwReserved : UINT_PTR -> "sptr"; WINHTTP_STATUS_CALLBACK WinHttpSetStatusCallback(void* hInternet, WINHTTP_STATUS_CALLBACK lpfnInternetCallback, DWORD dwNotificationFlags, UINT_PTR dwReserved)
#uselib "WINHTTP.dll"
#cfunc global WinHttpSetStatusCallback "WinHttpSetStatusCallback" intptr, intptr, int, intptr
; res = WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
; hInternet : void* in/out -> "intptr"
; lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> "intptr"
; dwNotificationFlags : DWORD -> "int"
; dwReserved : UINT_PTR -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
procWinHttpSetStatusCallback = winhttp.NewProc("WinHttpSetStatusCallback")
)
// hInternet (void* in/out), lpfnInternetCallback (WINHTTP_STATUS_CALLBACK), dwNotificationFlags (DWORD), dwReserved (UINT_PTR)
r1, _, err := procWinHttpSetStatusCallback.Call(
uintptr(hInternet),
uintptr(lpfnInternetCallback),
uintptr(dwNotificationFlags),
uintptr(dwReserved),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WINHTTP_STATUS_CALLBACKfunction WinHttpSetStatusCallback(
hInternet: Pointer; // void* in/out
lpfnInternetCallback: Pointer; // WINHTTP_STATUS_CALLBACK
dwNotificationFlags: DWORD; // DWORD
dwReserved: NativeUInt // UINT_PTR
): Pointer; stdcall;
external 'WINHTTP.dll' name 'WinHttpSetStatusCallback';result := DllCall("WINHTTP\WinHttpSetStatusCallback"
, "Ptr", hInternet ; void* in/out
, "Ptr", lpfnInternetCallback ; WINHTTP_STATUS_CALLBACK
, "UInt", dwNotificationFlags ; DWORD
, "UPtr", dwReserved ; UINT_PTR
, "Ptr") ; return: WINHTTP_STATUS_CALLBACK●WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved) = DLL("WINHTTP.dll", "void* WinHttpSetStatusCallback(void*, void*, dword, int)")
# 呼び出し: WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
# hInternet : void* in/out -> "void*"
# lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> "void*"
# dwNotificationFlags : DWORD -> "dword"
# dwReserved : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winhttp" fn WinHttpSetStatusCallback(
hInternet: ?*anyopaque, // void* in/out
lpfnInternetCallback: ?*anyopaque, // WINHTTP_STATUS_CALLBACK
dwNotificationFlags: u32, // DWORD
dwReserved: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc WinHttpSetStatusCallback(
hInternet: pointer, # void* in/out
lpfnInternetCallback: pointer, # WINHTTP_STATUS_CALLBACK
dwNotificationFlags: uint32, # DWORD
dwReserved: uint # UINT_PTR
): pointer {.importc: "WinHttpSetStatusCallback", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
void* WinHttpSetStatusCallback(
void* hInternet, // void* in/out
void* lpfnInternetCallback, // WINHTTP_STATUS_CALLBACK
uint dwNotificationFlags, // DWORD
size_t dwReserved // UINT_PTR
);ccall((:WinHttpSetStatusCallback, "WINHTTP.dll"), stdcall, Ptr{Cvoid},
(Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Csize_t),
hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
# hInternet : void* in/out -> Ptr{Cvoid}
# lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> Ptr{Cvoid}
# dwNotificationFlags : DWORD -> UInt32
# dwReserved : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* WinHttpSetStatusCallback(
void* hInternet,
void* lpfnInternetCallback,
uint32_t dwNotificationFlags,
uintptr_t dwReserved);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
-- hInternet : void* in/out
-- lpfnInternetCallback : WINHTTP_STATUS_CALLBACK
-- dwNotificationFlags : DWORD
-- dwReserved : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpSetStatusCallback = lib.func('__stdcall', 'WinHttpSetStatusCallback', 'void *', ['void *', 'void *', 'uint32_t', 'uintptr_t']);
// WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
// hInternet : void* in/out -> 'void *'
// lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> 'void *'
// dwNotificationFlags : DWORD -> 'uint32_t'
// dwReserved : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpSetStatusCallback: { parameters: ["pointer", "pointer", "u32", "usize"], result: "pointer" },
});
// lib.symbols.WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved)
// hInternet : void* in/out -> "pointer"
// lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> "pointer"
// dwNotificationFlags : DWORD -> "u32"
// dwReserved : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* WinHttpSetStatusCallback(
void* hInternet,
void* lpfnInternetCallback,
uint32_t dwNotificationFlags,
size_t dwReserved);
C, "WINHTTP.dll");
// $ffi->WinHttpSetStatusCallback(hInternet, lpfnInternetCallback, dwNotificationFlags, dwReserved);
// hInternet : void* in/out
// lpfnInternetCallback : WINHTTP_STATUS_CALLBACK
// dwNotificationFlags : DWORD
// dwReserved : UINT_PTR
// 構造体/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 Winhttp extends StdCallLibrary {
Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
Pointer WinHttpSetStatusCallback(
Pointer hInternet, // void* in/out
Callback lpfnInternetCallback, // WINHTTP_STATUS_CALLBACK
int dwNotificationFlags, // DWORD
long dwReserved // UINT_PTR
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpSetStatusCallback = WinHttpSetStatusCallback(
hInternet : Void*, # void* in/out
lpfnInternetCallback : Void*, # WINHTTP_STATUS_CALLBACK
dwNotificationFlags : UInt32, # DWORD
dwReserved : LibC::SizeT # UINT_PTR
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpSetStatusCallbackNative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, Uint32, UintPtr);
typedef WinHttpSetStatusCallbackDart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, int, int);
final WinHttpSetStatusCallback = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpSetStatusCallbackNative, WinHttpSetStatusCallbackDart>('WinHttpSetStatusCallback');
// hInternet : void* in/out -> Pointer<Void>
// lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> Pointer<Void>
// dwNotificationFlags : DWORD -> Uint32
// dwReserved : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHttpSetStatusCallback(
hInternet: Pointer; // void* in/out
lpfnInternetCallback: Pointer; // WINHTTP_STATUS_CALLBACK
dwNotificationFlags: DWORD; // DWORD
dwReserved: NativeUInt // UINT_PTR
): Pointer; stdcall;
external 'WINHTTP.dll' name 'WinHttpSetStatusCallback';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpSetStatusCallback"
c_WinHttpSetStatusCallback :: Ptr () -> Ptr () -> Word32 -> CUIntPtr -> IO (Ptr ())
-- hInternet : void* in/out -> Ptr ()
-- lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> Ptr ()
-- dwNotificationFlags : DWORD -> Word32
-- dwReserved : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpsetstatuscallback =
foreign "WinHttpSetStatusCallback"
((ptr void) @-> (ptr void) @-> uint32_t @-> size_t @-> returning (ptr void))
(* hInternet : void* in/out -> (ptr void) *)
(* lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> (ptr void) *)
(* dwNotificationFlags : DWORD -> uint32_t *)
(* dwReserved : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpSetStatusCallback" win-http-set-status-callback :convention :stdcall) :pointer
(h-internet :pointer) ; void* in/out
(lpfn-internet-callback :pointer) ; WINHTTP_STATUS_CALLBACK
(dw-notification-flags :uint32) ; DWORD
(dw-reserved :uint64)) ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpSetStatusCallback = Win32::API::More->new('WINHTTP',
'LPVOID WinHttpSetStatusCallback(LPVOID hInternet, LPVOID lpfnInternetCallback, DWORD dwNotificationFlags, WPARAM dwReserved)');
# my $ret = $WinHttpSetStatusCallback->Call($hInternet, $lpfnInternetCallback, $dwNotificationFlags, $dwReserved);
# hInternet : void* in/out -> LPVOID
# lpfnInternetCallback : WINHTTP_STATUS_CALLBACK -> LPVOID
# dwNotificationFlags : DWORD -> DWORD
# dwReserved : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
- f WinHttpConnect — 指定サーバーへの接続を確立し接続ハンドルを返す。
- f WinHttpOpen — WinHTTPセッションを初期化しセッションハンドルを返す。