This topic has not yet been rated - Rate this topic

PxeGetServerInfoEx function

Returns information about the PXE server.

For more information about the OPTION_SERVERID option, developers should refer to the Dynamic Host Configuration Protocol for IPv6 (RFC 3315) maintained by The Internet Engineering Task Force (IETF).

Syntax

C++


DWORD PXEAPI PxeGetServerInfoEx(
  _In_   PXE_GSI_TYPE uInfoType,
  _Out_  PVOID pBuffer,
  _In_   ULONG uBufferLen,
  _Out_  PULONG puBufferUsed
);

Parameters

uInfoType [in]

Selects the information that will be returned.

Value	Meaning
PXE_GSI_TRACE_ENABLED 1	Returns a BOOL that indicates whether tracing is enabled for the server. TRUE indicates that tracing is enabled.
PXE_GSI_SERVER_DUID 2	Returns a byte array that corresponds to the DHCPv6 DUID that is sent to DHCPv6 PXE clients in response packets in the OPTION_SERVERID option. PXE_GSI_SERVER_DUID cannot be used with PxeGetServerInfo.

pBuffer [out]

Address of a buffer that will receive the results of the query. The size and format of the results depends on the value of the uInfoType parameter.

uBufferLen [in]

Size of buffer pointed to by the pBuffer parameter.

puBufferUsed [out]

Size of buffer pointed to by the pBuffer parameter.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Requirements

Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Header	WdsPxe.h
Library	WdsPxe.lib
DLL	WdsPxe.dll

Community Additions