WdsBpParseInitialize function

Receives a handle to the packet sent by the network boot program.

Syntax


HRESULT WDSBPAPI WdsBpParseInitialize(
  _In_      PVOID  pPacket,
  _In_      ULONG  uPacketLen,
  _Out_opt_ PBYTE  pbPacketType,
  _Out_     HANDLE *phHandle
);

Parameters

pPacket [in]

A pointer to the packet received from the WDS client. The packet must be a valid DHCP packet.

uPacketLen [in]

The length of the packet, in bytes.

pbPacketType [out, optional]

A value that indicates the type of boot program that sent the packet. The bit flags in the following table can be combined.

ValueMeaning
WDSBP_PK_TYPE_DHCP
1

The presence of this value indicates that the packet is a DHCP packet.

WDSBP_PK_TYPE_WDSNBP
2

This presence of this value indicates that the DHCP packet came from the WDS network boot program. If this value is absent the type of client was not recognized.

WDSBP_PK_TYPE_BCD
4

The presence of this value indicates that the packet contains a path to a Boot Configuration Data (BCD) file.

 

phHandle [out]

A handle to the packet. This handle can be used by the WdsBpQueryOption function and must be closed using the WdsBpCloseHandle function.

Return value

If the function succeeds, the return is S_OK.

Requirements

Minimum supported client

Windows Vista with SP1 [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wdsbp.h

Library

Wdsbp.lib

DLL

Wdsbp.dll

 

 

Community Additions

ADD
Show: