Win32 API 日本語リファレンス
ホーム › NetworkManagement.Dhcp › DHCP_CALLOUT_TABLE

DHCP_CALLOUT_TABLE

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 80 バイト / x86: 40 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
DhcpControlHookLPDHCP_CONTROL8/4+0+0サードパーティ製 DLL に実装された DhcpControlHook 関数へのポインターです。この関数は、Microsoft DHCP Server が開始、停止、一時停止、または再開されたときに呼び出されます。通知が不要な場合は NULL を設定します。
DhcpNewPktHookLPDHCP_NEWPKT8/4+8+4サードパーティ製 DLL に実装された DhcpNewPktHook 関数へのポインターです。この関数は、Microsoft DHCP Server が処理を試みるパケットを受信したときに呼び出されます。通知が不要な場合は NULL を設定します。
DhcpPktDropHookLPDHCP_DROP_SEND8/4+16+8サードパーティ製 DLL に実装された DhcpPktDropHook 関数へのポインターです。この関数は、Microsoft DHCP Server がパケットを破棄したとき、および Microsoft DHCP Server がパケットの処理を完全に終えたときに呼び出されます。通知が不要な場合は NULL を設定します。
DhcpPktSendHookLPDHCP_DROP_SEND8/4+24+12サードパーティ製 DLL に実装された DhcpPktSendHook 関数へのポインターです。この関数は、Microsoft DHCP Server がクライアントからの問い合わせに対する応答を送信する直前に呼び出されます。通知が不要な場合は NULL を設定します。
DhcpAddressDelHookLPDHCP_PROB8/4+32+16サードパーティ製 DLL に実装された DhcpAddressDelHook 関数へのポインターです。この関数は、Microsoft DHCP Server で指定されたイベントが発生し、その結果としてパケットが破棄されたときに呼び出されます。通知が不要な場合は NULL を設定します。
DhcpAddressOfferHookLPDHCP_GIVE_ADDRESS8/4+40+20サードパーティ製 DLL に実装された DhcpAddressOfferHook 関数へのポインターです。この関数は、Microsoft DHCP Server が DHCP REQUEST メッセージへの応答として DHCP ACK メッセージを送信する直前に呼び出されます。通知が不要な場合は NULL を設定します。
DhcpHandleOptionsHookLPDHCP_HANDLE_OPTIONS8/4+48+24サードパーティ製 DLL に実装された DhcpHandleOptionsHook 関数へのポインターです。この関数は、解析済みの DHCP 情報のみをサードパーティ製 DLL に送信し、サードパーティ製 DLL が DHCP パケット全体を処理せずに済むようにします。通知が不要な場合は NULL を設定します。
DhcpDeleteClientHookLPDHCP_DELETE_CLIENT8/4+56+28サードパーティ製 DLL に実装された DhcpDeleteClientHook 関数へのポインターです。この関数は、Microsoft DHCP Server がアクティブなリースのデータベースからクライアントのリースを削除する直前に呼び出されます。通知が不要な場合は NULL を設定します。
DhcpExtensionHookvoid*8/4+64+32将来使用するために予約済みです。
DhcpReservedHookvoid*8/4+72+36将来使用するために予約済みです。

公式ドキュメント

DHCP_CALLOUT_TABLE 構造体は、DHCP サーバーのイベントに関する通知要求を送信するために、Microsoft DHCP Server およびサードパーティ製 DLL によって使用されます。

解説(Remarks)

Microsoft DHCP Server で利用できるすべてのフックを実装する必要はありません。特定のイベントの通知が不要な場合は、そのメンバーに NULL を設定します。ただし、最初に読み込まれたサードパーティ製 DLL は後続のサードパーティ製 DLL を読み込む責任を負い、後続の DLL では本来 NULL となるはずのイベントの通知を必要とする場合があることに注意してください。その結果、連鎖するサードパーティ製 DLL が使用するメンバーには、本来であれば未使用であっても NULL 以外の値が設定されることになります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// DHCP_CALLOUT_TABLE  (x64 80 / x86 40 バイト)
typedef struct DHCP_CALLOUT_TABLE {
    LPDHCP_CONTROL DhcpControlHook;
    LPDHCP_NEWPKT DhcpNewPktHook;
    LPDHCP_DROP_SEND DhcpPktDropHook;
    LPDHCP_DROP_SEND DhcpPktSendHook;
    LPDHCP_PROB DhcpAddressDelHook;
    LPDHCP_GIVE_ADDRESS DhcpAddressOfferHook;
    LPDHCP_HANDLE_OPTIONS DhcpHandleOptionsHook;
    LPDHCP_DELETE_CLIENT DhcpDeleteClientHook;
    void* DhcpExtensionHook;
    void* DhcpReservedHook;
} DHCP_CALLOUT_TABLE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DHCP_CALLOUT_TABLE
{
    public IntPtr DhcpControlHook;
    public IntPtr DhcpNewPktHook;
    public IntPtr DhcpPktDropHook;
    public IntPtr DhcpPktSendHook;
    public IntPtr DhcpAddressDelHook;
    public IntPtr DhcpAddressOfferHook;
    public IntPtr DhcpHandleOptionsHook;
    public IntPtr DhcpDeleteClientHook;
    public IntPtr DhcpExtensionHook;
    public IntPtr DhcpReservedHook;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DHCP_CALLOUT_TABLE
    Public DhcpControlHook As IntPtr
    Public DhcpNewPktHook As IntPtr
    Public DhcpPktDropHook As IntPtr
    Public DhcpPktSendHook As IntPtr
    Public DhcpAddressDelHook As IntPtr
    Public DhcpAddressOfferHook As IntPtr
    Public DhcpHandleOptionsHook As IntPtr
    Public DhcpDeleteClientHook As IntPtr
    Public DhcpExtensionHook As IntPtr
    Public DhcpReservedHook As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class DHCP_CALLOUT_TABLE(ctypes.Structure):
    _fields_ = [
        ("DhcpControlHook", ctypes.c_void_p),
        ("DhcpNewPktHook", ctypes.c_void_p),
        ("DhcpPktDropHook", ctypes.c_void_p),
        ("DhcpPktSendHook", ctypes.c_void_p),
        ("DhcpAddressDelHook", ctypes.c_void_p),
        ("DhcpAddressOfferHook", ctypes.c_void_p),
        ("DhcpHandleOptionsHook", ctypes.c_void_p),
        ("DhcpDeleteClientHook", ctypes.c_void_p),
        ("DhcpExtensionHook", ctypes.c_void_p),
        ("DhcpReservedHook", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct DHCP_CALLOUT_TABLE {
    pub DhcpControlHook: *mut core::ffi::c_void,
    pub DhcpNewPktHook: *mut core::ffi::c_void,
    pub DhcpPktDropHook: *mut core::ffi::c_void,
    pub DhcpPktSendHook: *mut core::ffi::c_void,
    pub DhcpAddressDelHook: *mut core::ffi::c_void,
    pub DhcpAddressOfferHook: *mut core::ffi::c_void,
    pub DhcpHandleOptionsHook: *mut core::ffi::c_void,
    pub DhcpDeleteClientHook: *mut core::ffi::c_void,
    pub DhcpExtensionHook: *mut core::ffi::c_void,
    pub DhcpReservedHook: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type DHCP_CALLOUT_TABLE struct {
	DhcpControlHook uintptr
	DhcpNewPktHook uintptr
	DhcpPktDropHook uintptr
	DhcpPktSendHook uintptr
	DhcpAddressDelHook uintptr
	DhcpAddressOfferHook uintptr
	DhcpHandleOptionsHook uintptr
	DhcpDeleteClientHook uintptr
	DhcpExtensionHook uintptr
	DhcpReservedHook uintptr
}
type
  DHCP_CALLOUT_TABLE = record
    DhcpControlHook: Pointer;
    DhcpNewPktHook: Pointer;
    DhcpPktDropHook: Pointer;
    DhcpPktSendHook: Pointer;
    DhcpAddressDelHook: Pointer;
    DhcpAddressOfferHook: Pointer;
    DhcpHandleOptionsHook: Pointer;
    DhcpDeleteClientHook: Pointer;
    DhcpExtensionHook: Pointer;
    DhcpReservedHook: Pointer;
  end;
const DHCP_CALLOUT_TABLE = extern struct {
    DhcpControlHook: ?*anyopaque,
    DhcpNewPktHook: ?*anyopaque,
    DhcpPktDropHook: ?*anyopaque,
    DhcpPktSendHook: ?*anyopaque,
    DhcpAddressDelHook: ?*anyopaque,
    DhcpAddressOfferHook: ?*anyopaque,
    DhcpHandleOptionsHook: ?*anyopaque,
    DhcpDeleteClientHook: ?*anyopaque,
    DhcpExtensionHook: ?*anyopaque,
    DhcpReservedHook: ?*anyopaque,
};
type
  DHCP_CALLOUT_TABLE {.bycopy.} = object
    DhcpControlHook: pointer
    DhcpNewPktHook: pointer
    DhcpPktDropHook: pointer
    DhcpPktSendHook: pointer
    DhcpAddressDelHook: pointer
    DhcpAddressOfferHook: pointer
    DhcpHandleOptionsHook: pointer
    DhcpDeleteClientHook: pointer
    DhcpExtensionHook: pointer
    DhcpReservedHook: pointer
struct DHCP_CALLOUT_TABLE
{
    void* DhcpControlHook;
    void* DhcpNewPktHook;
    void* DhcpPktDropHook;
    void* DhcpPktSendHook;
    void* DhcpAddressDelHook;
    void* DhcpAddressOfferHook;
    void* DhcpHandleOptionsHook;
    void* DhcpDeleteClientHook;
    void* DhcpExtensionHook;
    void* DhcpReservedHook;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; DHCP_CALLOUT_TABLE サイズ: 40 バイト(x86)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; DhcpControlHook : LPDHCP_CONTROL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; DhcpNewPktHook : LPDHCP_NEWPKT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; DhcpPktDropHook : LPDHCP_DROP_SEND (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DhcpPktSendHook : LPDHCP_DROP_SEND (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; DhcpAddressDelHook : LPDHCP_PROB (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; DhcpAddressOfferHook : LPDHCP_GIVE_ADDRESS (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; DhcpHandleOptionsHook : LPDHCP_HANDLE_OPTIONS (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; DhcpDeleteClientHook : LPDHCP_DELETE_CLIENT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; DhcpExtensionHook : void* (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; DhcpReservedHook : void* (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; DHCP_CALLOUT_TABLE サイズ: 80 バイト(x64)
dim st, 20    ; 4byte整数×20(構造体サイズ 80 / 4 切り上げ)
; DhcpControlHook : LPDHCP_CONTROL (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; DhcpNewPktHook : LPDHCP_NEWPKT (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; DhcpPktDropHook : LPDHCP_DROP_SEND (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; DhcpPktSendHook : LPDHCP_DROP_SEND (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; DhcpAddressDelHook : LPDHCP_PROB (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; DhcpAddressOfferHook : LPDHCP_GIVE_ADDRESS (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; DhcpHandleOptionsHook : LPDHCP_HANDLE_OPTIONS (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; DhcpDeleteClientHook : LPDHCP_DELETE_CLIENT (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; DhcpExtensionHook : void* (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; DhcpReservedHook : void* (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global DHCP_CALLOUT_TABLE
    #field intptr DhcpControlHook
    #field intptr DhcpNewPktHook
    #field intptr DhcpPktDropHook
    #field intptr DhcpPktSendHook
    #field intptr DhcpAddressDelHook
    #field intptr DhcpAddressOfferHook
    #field intptr DhcpHandleOptionsHook
    #field intptr DhcpDeleteClientHook
    #field intptr DhcpExtensionHook
    #field intptr DhcpReservedHook
#endstruct

stdim st, DHCP_CALLOUT_TABLE        ; NSTRUCT 変数を確保