Edit

DHCP_CALLOUT_TABLE structure (dhcpssdk.h)

  • Article

The DHCP_CALLOUT_TABLE structure is used by Microsoft DHCP Server and third-party DLLs to send notification requests for DHCP Server events.

Syntax

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;
  LPVOID                DhcpExtensionHook;
  LPVOID                DhcpReservedHook;
} DHCP_CALLOUT_TABLE, *LPDHCP_CALLOUT_TABLE;

Members

DhcpControlHook

Pointer to a DhcpControlHook function, implemented in a third-party DLL, to be called when Microsoft DHCP Server is started, stopped, paused, or continued. Set to NULL if notification is not required.

DhcpNewPktHook

Pointer to a DhcpNewPktHook function, implemented in a third-party DLL, to be called when Microsoft DHCP Server receives a packet that it attempts to process. Set to NULL if notification is not required.

DhcpPktDropHook

Pointer to a DhcpPktDropHook function, implemented in a third-party DLL, to be called when Microsoft DHCP Server drops a packet, and when a packet is completely processed by Microsoft DHCP Server. Set to NULL if notification is not required.

DhcpPktSendHook

Pointer to a DhcpPktSendHook function, implemented in a third-party DLL, to be called directly before Microsoft DHCP Server submits a response to a client inquiry. Set to NULL if notification is not required.

DhcpAddressDelHook

Pointer to a DhcpAddressDelHook function, implemented in a third-party DLL, to be called when a specified event in Microsoft DHCP Server results in a packet being dropped. Set to NULL if notification is not required.

DhcpAddressOfferHook

Pointer to a DhcpAddressOfferHook function, implemented in a third-party DLL, to be called directly before Microsoft DHCP Server submits a DHCP ACK message in response to a DHCP REQUEST message. Set to NULL if notification is not required.

DhcpHandleOptionsHook

Pointer to a DhcpHandleOptionsHook function, implemented in a third-party DLL, that sends only parsed DHCP information to the third-party DLL, enabling the third-party DLL to avoid processing the entire DHCP packet. Set to NULL if notification is not required.

DhcpDeleteClientHook

Pointer to a DhcpDeleteClientHook function, implemented in a third-party DLL, to be called directly before Microsoft DHCP Server deletes a client lease from its active leases database. Set to NULL if notification is not required.

DhcpExtensionHook

Reserved for future use.

DhcpReservedHook

Reserved for future use.

Remarks

It is not necessary to implement all hooks available from Microsoft DHCP Server. If notification for a particular event is not required, set the member to NULL. Remember, however, that the initially loaded third-party DLL is responsible for loading subsequent third-party DLLs, and that subsequent DLLs may require notification of events that otherwise would be NULL, resulting in a non-NULL setting for members used by chained third-party DLLs that would otherwise be unused.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Header dhcpssdk.h

See also

Chaining Multiple Third-Party DLLs

DhcpAddressDelHook

DhcpAddressOfferHook

DhcpControlHook

DhcpDeleteClientHook

DhcpHandleOptionsHook

DhcpNewPktHook

DhcpPktDropHook

DhcpPktSendHook

DhcpServerCalloutEntry