Edit

Share via

PxeProviderSetAttribute function (wdspxe.h)

  • Article

Specifies attributes for the provider.

Syntax

DWORD PXEAPI PxeProviderSetAttribute(
  [in] HANDLE                 hProvider,
  [in] PXE_PROVIDER_ATTRIBUTE Attribute,
  [in] PVOID                  pParameterBuffer,
  [in] ULONG                  uParamLen
);

Parameters

[in] hProvider

HANDLE passed to the PxeProviderInitialize function.

[in] Attribute

Identifies the attribute to set.

Value Meaning
PXE_PROV_ATTR_FILTER
0
 The pParameterBuffer parameter points to a ULONG.
PXE_PROV_ATTR_FILTER_IPV6
1
 The pParameterBuffer parameter points to a ULONG. Use this attribute with DHCPv6 packets. Available beginning with Windows 8 and Windows Server 2012.
PXE_PROV_ATTR_IPV6_CAPABLE
2
 Pointer to a BOOL value that is TRUE to indicate the provider is capable of processing IPv6 packets. By default, the server assumes a provider is not capable of processing IPv6 packets and will not deliver them. Available beginning with Windows 8 and Windows Server 2012.

[in] pParameterBuffer

Pointer to a buffer. The size and contents of this buffer vary depending on the value of the Attribute parameter.

If Attribute is PXE_PROV_ATTR_FILTER, the buffer contains one of the following values.

Value Meaning
PXE_PROV_FILTER_ALL
0x0000
 Provider is to see all packets.
PXE_PROV_FILTER_DHCP_ONLY
0x0001
 Provider will see only DHCP packets. If PXE_PROV_ATTR_FILTER_IPV6, the provider will see only only DHCPv6 packets
PXE_PROV_FILTER_PXE_ONLY
0x0002
 Provider will see only DHCP packets that specify the DHCP Vendor Class Identifier option (60) as "PXEClient". If PXE_PROV_ATTR_FILTER_IPV6, provider will see only packets that specify a DHCPv6 OPTION_VENDOR_CLASS containing the “PXEClient”.

[in] uParamLen

The size of the buffer pointed to by the pParameterBuffer parameter.

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

PxeProviderRecvRequest

Windows Deployment Services Server Functions