PxeRegisterCallback function (wdspxe.h)

Registers callback functions for different notification events.

Syntax

DWORD PXEAPI PxeRegisterCallback(
  [in] HANDLE            hProvider,
  [in] PXE_CALLBACK_TYPE CallbackType,
  [in] PVOID             pCallbackFunction,
  [in] PVOID             pContext
);

Parameters

[in] hProvider

HANDLE passed to the PxeProviderInitialize function.

[in] CallbackType

Specifies the callback that is being registered.

Value	Meaning
PXE_CALLBACK_RECV_REQUEST 0	Register the PxeProviderRecvRequest callback. This callback must be registered while the provider is processing the PxeProviderInitialize function or the provider will be shut down.
PXE_CALLBACK_SHUTDOWN 1	Register the PxeProviderShutdown callback. This callback must be registered while the provider is processing the PxeProviderInitialize function or the provider will be shut down.
PXE_CALLBACK_SERVICE_CONTROL 2	Register the PxeProviderServiceControl callback.
PXE_CALLBACK_MAX 3	Used to determine an out-of-range index. Values greater than or equal to PXE_CALLBACK_MAX are not valid.

[in] pCallbackFunction

Address of the callback function. The function signature varies depending on the CallbackType parameter.

[in] pContext

Context value to be passed to the callback function.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008, Windows Server 2003 with SP2 [desktop apps only]
Target Platform	Windows
Header	wdspxe.h
Library	WdsPxe.lib
DLL	WdsPxe.dll

See also

PxeProviderInitialize

PxeProviderRecvRequest

PxeProviderServiceControl

PxeProviderShutdown

Windows Deployment Services Server Functions