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

InternetSetStatusCallbackW

関数
WinINetハンドルに状態通知コールバック関数を登録する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

LPINTERNET_STATUS_CALLBACK InternetSetStatusCallbackW(
    void* hInternet,
    LPINTERNET_STATUS_CALLBACK lpfnInternetCallback   // optional
);

パラメーター

名前型方向説明
hInternetvoid*inコールバックを設定する対象のハンドル。
lpfnInternetCallbackLPINTERNET_STATUS_CALLBACKinoptional進行があったときに呼び出すコールバック関数へのポインター。既存のコールバック関数を削除する場合は NULL を指定します。コールバック関数の詳細については、 InternetStatusCallback を参照してください。

戻り値の型: LPINTERNET_STATUS_CALLBACK

公式ドキュメント

InternetSetStatusCallbackW (Unicode) 関数は、操作の進行中に WinINet 関数が呼び出すことのできるコールバック関数を設定します。

戻り値

成功した場合は以前に定義されていたステータスコールバック関数を返します。以前に定義されたステータスコールバック関数が存在しない場合は NULL を返し、コールバック関数が有効でない場合は INTERNET_INVALID_STATUS_CALLBACK を返します。

解説(Remarks)

同期関数と非同期関数のいずれも、名前解決やサーバーへの接続などの要求の進行状況を示すためにコールバック関数を使用します。非同期操作にはコールバック関数が必須です。非同期要求は、要求が完了したことを示すために INTERNET_STATUS_REQUEST_COMPLETE を指定してアプリケーションへコールバックします。

コールバック関数は任意のハンドルに設定でき、派生ハンドルに継承されます。コールバック関数は、以前のコールバック値を使用する必要がある保留中の要求が存在しない限り、 InternetSetStatusCallback を使用して変更できます。ただし、あるハンドルのコールバック関数を変更しても、 InternetConnect が返すような派生ハンドルのコールバックは変更されない点に注意してください。各レベルでコールバック関数を変更する必要があります。

多くの WinINet 関数は、ネットワーク上で複数の操作を実行します。各操作には完了までに時間がかかる場合があり、それぞれ失敗する可能性があります。

長時間にわたる操作中にステータス情報を表示したい場合があります。いずれかのコールバックまたは非同期関数が保留中である限り削除できない Internet ステータスコールバック関数を設定することで、ステータス情報を表示できます。

InternetSetStatusCallback を開始した後は、時間のかかるネットワーク操作を監視するために、任意の WinINet 関数内からコールバック関数にアクセスできます。

Note lpfnInternetCallback パラメーターで指定したコールバック関数は、HttpOpenRequest の dwContext パラメーターが 0 (INTERNET_NO_CALLBACK) に設定されている場合の要求ハンドル、または InternetConnect の dwContext ハンドルが 0 (INTERNET_NO_CALLBACK) に設定されている場合の接続ハンドルに対する非同期操作では呼び出されません。

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

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

wininet.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして InternetSetStatusCallback を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、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>

LPINTERNET_STATUS_CALLBACK InternetSetStatusCallbackW(
    void* hInternet,
    LPINTERNET_STATUS_CALLBACK lpfnInternetCallback   // optional
);
[DllImport("WININET.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr InternetSetStatusCallbackW(
    IntPtr hInternet,   // void*
    IntPtr lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function InternetSetStatusCallbackW(
    hInternet As IntPtr,   ' void*
    lpfnInternetCallback As IntPtr   ' LPINTERNET_STATUS_CALLBACK optional
) As IntPtr
End Function
' hInternet : void*
' lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
Declare PtrSafe Function InternetSetStatusCallbackW Lib "wininet" ( _
    ByVal hInternet As LongPtr, _
    ByVal lpfnInternetCallback As LongPtr) As LongPtr
' 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

InternetSetStatusCallbackW = ctypes.windll.wininet.InternetSetStatusCallbackW
InternetSetStatusCallbackW.restype = ctypes.c_void_p
InternetSetStatusCallbackW.argtypes = [
    ctypes.POINTER(None),  # hInternet : void*
    ctypes.c_void_p,  # lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetSetStatusCallbackW = Fiddle::Function.new(
  lib['InternetSetStatusCallbackW'],
  [
    Fiddle::TYPE_VOIDP,  # hInternet : void*
    Fiddle::TYPE_VOIDP,  # lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn InternetSetStatusCallbackW(
        hInternet: *mut (),  // void*
        lpfnInternetCallback: *const core::ffi::c_void  // LPINTERNET_STATUS_CALLBACK optional
    ) -> *const core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr InternetSetStatusCallbackW(IntPtr hInternet, IntPtr lpfnInternetCallback);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetStatusCallbackW' -Namespace Win32 -PassThru
# $api::InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
#uselib "WININET.dll"
#func global InternetSetStatusCallbackW "InternetSetStatusCallbackW" wptr, wptr
; InternetSetStatusCallbackW hInternet, lpfnInternetCallback   ; 戻り値は stat
; hInternet : void* -> "wptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetSetStatusCallbackW "InternetSetStatusCallbackW" sptr, sptr
; res = InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
; hInternet : void* -> "sptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "sptr"
; LPINTERNET_STATUS_CALLBACK InternetSetStatusCallbackW(void* hInternet, LPINTERNET_STATUS_CALLBACK lpfnInternetCallback)
#uselib "WININET.dll"
#cfunc global InternetSetStatusCallbackW "InternetSetStatusCallbackW" intptr, intptr
; res = InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
; hInternet : void* -> "intptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetStatusCallbackW = wininet.NewProc("InternetSetStatusCallbackW")
)

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

extern "wininet" fn InternetSetStatusCallbackW(
    hInternet: ?*anyopaque, // void*
    lpfnInternetCallback: ?*anyopaque // LPINTERNET_STATUS_CALLBACK optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc InternetSetStatusCallbackW(
    hInternet: pointer,  # void*
    lpfnInternetCallback: pointer  # LPINTERNET_STATUS_CALLBACK optional
): pointer {.importc: "InternetSetStatusCallbackW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
void* InternetSetStatusCallbackW(
    void* hInternet,   // void*
    void* lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
);
ccall((:InternetSetStatusCallbackW, "WININET.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Ptr{Cvoid}),
      hInternet, lpfnInternetCallback)
# hInternet : void* -> Ptr{Cvoid}
# lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* InternetSetStatusCallbackW(
    void* hInternet,
    void* lpfnInternetCallback);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
-- hInternet : void*
-- lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
-- 構造体/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 InternetSetStatusCallbackW = lib.func('__stdcall', 'InternetSetStatusCallbackW', 'void *', ['void *', 'void *']);
// InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
// hInternet : void* -> 'void *'
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("WININET.dll", {
  InternetSetStatusCallbackW: { parameters: ["pointer", "pointer"], result: "pointer" },
});
// lib.symbols.InternetSetStatusCallbackW(hInternet, lpfnInternetCallback)
// hInternet : void* -> "pointer"
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* InternetSetStatusCallbackW(
    void* hInternet,
    void* lpfnInternetCallback);
C, "WININET.dll");
// $ffi->InternetSetStatusCallbackW(hInternet, lpfnInternetCallback);
// hInternet : void*
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK 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.UNICODE_OPTIONS);
    Pointer InternetSetStatusCallbackW(
        Pointer hInternet,   // void*
        Callback lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun InternetSetStatusCallbackW = InternetSetStatusCallbackW(
    hInternet : Void*,   # void*
    lpfnInternetCallback : Void*   # LPINTERNET_STATUS_CALLBACK optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetSetStatusCallbackWNative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>);
typedef InternetSetStatusCallbackWDart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>);
final InternetSetStatusCallbackW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetSetStatusCallbackWNative, InternetSetStatusCallbackWDart>('InternetSetStatusCallbackW');
// hInternet : void* -> Pointer<Void>
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetSetStatusCallbackW(
  hInternet: Pointer;   // void*
  lpfnInternetCallback: Pointer   // LPINTERNET_STATUS_CALLBACK optional
): Pointer; stdcall;
  external 'WININET.dll' name 'InternetSetStatusCallbackW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetSetStatusCallbackW"
  c_InternetSetStatusCallbackW :: Ptr () -> Ptr () -> IO (Ptr ())
-- hInternet : void* -> Ptr ()
-- lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetsetstatuscallbackw =
  foreign "InternetSetStatusCallbackW"
    ((ptr void) @-> (ptr void) @-> returning (ptr void))
(* hInternet : void* -> (ptr void) *)
(* lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetSetStatusCallbackW" internet-set-status-callback-w :convention :stdcall) :pointer
  (h-internet :pointer)   ; void*
  (lpfn-internet-callback :pointer))   ; LPINTERNET_STATUS_CALLBACK optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetSetStatusCallbackW = Win32::API::More->new('WININET',
    'LPVOID InternetSetStatusCallbackW(LPVOID hInternet, LPVOID lpfnInternetCallback)');
# my $ret = $InternetSetStatusCallbackW->Call($hInternet, $lpfnInternetCallback);
# hInternet : void* -> LPVOID
# lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型