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

InternetSetStatusCallbackA

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

シグネチャ

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

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

パラメーター

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

戻り値の型: LPINTERNET_STATUS_CALLBACK

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

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

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

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

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

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

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

wininet.h ヘッダーは、InternetSetStatusCallback を、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>

LPINTERNET_STATUS_CALLBACK InternetSetStatusCallbackA(
    void* hInternet,
    LPINTERNET_STATUS_CALLBACK lpfnInternetCallback   // optional
);
[DllImport("WININET.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr InternetSetStatusCallbackA(
    IntPtr hInternet,   // void*
    IntPtr lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function InternetSetStatusCallbackA(
    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 InternetSetStatusCallbackA Lib "wininet" ( _
    ByVal hInternet As LongPtr, _
    ByVal lpfnInternetCallback As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetSetStatusCallbackA = ctypes.windll.wininet.InternetSetStatusCallbackA
InternetSetStatusCallbackA.restype = ctypes.c_void_p
InternetSetStatusCallbackA.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')
InternetSetStatusCallbackA = Fiddle::Function.new(
  lib['InternetSetStatusCallbackA'],
  [
    Fiddle::TYPE_VOIDP,  # hInternet : void*
    Fiddle::TYPE_VOIDP,  # lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "wininet")]
extern "system" {
    fn InternetSetStatusCallbackA(
        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.Ansi)]
public static extern IntPtr InternetSetStatusCallbackA(IntPtr hInternet, IntPtr lpfnInternetCallback);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetSetStatusCallbackA' -Namespace Win32 -PassThru
# $api::InternetSetStatusCallbackA(hInternet, lpfnInternetCallback)
#uselib "WININET.dll"
#func global InternetSetStatusCallbackA "InternetSetStatusCallbackA" sptr, sptr
; InternetSetStatusCallbackA hInternet, lpfnInternetCallback   ; 戻り値は stat
; hInternet : void* -> "sptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetSetStatusCallbackA "InternetSetStatusCallbackA" sptr, sptr
; res = InternetSetStatusCallbackA(hInternet, lpfnInternetCallback)
; hInternet : void* -> "sptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "sptr"
; LPINTERNET_STATUS_CALLBACK InternetSetStatusCallbackA(void* hInternet, LPINTERNET_STATUS_CALLBACK lpfnInternetCallback)
#uselib "WININET.dll"
#cfunc global InternetSetStatusCallbackA "InternetSetStatusCallbackA" intptr, intptr
; res = InternetSetStatusCallbackA(hInternet, lpfnInternetCallback)
; hInternet : void* -> "intptr"
; lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetSetStatusCallbackA = wininet.NewProc("InternetSetStatusCallbackA")
)

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

extern "wininet" fn InternetSetStatusCallbackA(
    hInternet: ?*anyopaque, // void*
    lpfnInternetCallback: ?*anyopaque // LPINTERNET_STATUS_CALLBACK optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc InternetSetStatusCallbackA(
    hInternet: pointer,  # void*
    lpfnInternetCallback: pointer  # LPINTERNET_STATUS_CALLBACK optional
): pointer {.importc: "InternetSetStatusCallbackA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
void* InternetSetStatusCallbackA(
    void* hInternet,   // void*
    void* lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
);
ccall((:InternetSetStatusCallbackA, "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 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* InternetSetStatusCallbackA(
    void* hInternet,
    void* lpfnInternetCallback);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetSetStatusCallbackA(hInternet, lpfnInternetCallback)
-- hInternet : void*
-- lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetSetStatusCallbackA = lib.func('__stdcall', 'InternetSetStatusCallbackA', 'void *', ['void *', 'void *']);
// InternetSetStatusCallbackA(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", {
  InternetSetStatusCallbackA: { parameters: ["pointer", "pointer"], result: "pointer" },
});
// lib.symbols.InternetSetStatusCallbackA(hInternet, lpfnInternetCallback)
// hInternet : void* -> "pointer"
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* InternetSetStatusCallbackA(
    void* hInternet,
    void* lpfnInternetCallback);
C, "WININET.dll");
// $ffi->InternetSetStatusCallbackA(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.ASCII_OPTIONS);
    Pointer InternetSetStatusCallbackA(
        Pointer hInternet,   // void*
        Callback lpfnInternetCallback   // LPINTERNET_STATUS_CALLBACK optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetSetStatusCallbackA = InternetSetStatusCallbackA(
    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 InternetSetStatusCallbackANative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>);
typedef InternetSetStatusCallbackADart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>);
final InternetSetStatusCallbackA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetSetStatusCallbackANative, InternetSetStatusCallbackADart>('InternetSetStatusCallbackA');
// hInternet : void* -> Pointer<Void>
// lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetSetStatusCallbackA(
  hInternet: Pointer;   // void*
  lpfnInternetCallback: Pointer   // LPINTERNET_STATUS_CALLBACK optional
): Pointer; stdcall;
  external 'WININET.dll' name 'InternetSetStatusCallbackA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetSetStatusCallbackA"
  c_InternetSetStatusCallbackA :: 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 internetsetstatuscallbacka =
  foreign "InternetSetStatusCallbackA"
    ((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 ("InternetSetStatusCallbackA" internet-set-status-callback-a :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 $InternetSetStatusCallbackA = Win32::API::More->new('WININET',
    'LPVOID InternetSetStatusCallbackA(LPVOID hInternet, LPVOID lpfnInternetCallback)');
# my $ret = $InternetSetStatusCallbackA->Call($hInternet, $lpfnInternetCallback);
# hInternet : void* -> LPVOID
# lpfnInternetCallback : LPINTERNET_STATUS_CALLBACK optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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