Edit

PxeProviderRegister function (wdspxe.h)

  • Article

Registers a provider with the system. Providers use this function during installation to register with the system. On successful registration, a registry key handle is returned that should be used to store configuration information.

Syntax

DWORD PXEAPI PxeProviderRegister(
  [in]  LPCWSTR       pszProviderName,
  [in]  LPCWSTR       pszModulePath,
  [in]  PXE_REG_INDEX Index,
  [in]  BOOL          bIsCritical,
  [out] PHKEY         phProviderKey
);

Parameters

[in] pszProviderName

Address of a null terminated string that specifies the display name of the provider. This name is displayed to the user and must be unique among registered providers.

[in] pszModulePath

Address of a null-terminated string that specifies the full path to the provider DLL.

[in] Index

Index into the list of providers. Any existing providers are shifted down if necessary. The administrator can rearrange the providers as needed, so no assumptions should be made about the order of providers.

Value Meaning
PXE_REG_INDEX_TOP
0
 Add the provider to the top of the list to be the first to receive client requests.
PXE_REG_INDEX_BOTTOM
0xFFFFFFFF
 Add the provider to the bottom of the list.

[in] bIsCritical

Indicates whether the provider is critical. If a critical provider fails, the WDS server will also fail.

[out] phProviderKey

Address of a HKEY where the configuration should be stored. The provider will receive a handle to this same key as the hProviderKey parameter to its PxeProviderInitialize callback.

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

PxeProviderUnRegister

Windows Deployment Services Server Functions