Expand Minimize

DhcpServerQueryAttribute function

The DhcpServerQueryAttribute function returns specific attribute information from the DHCP server.

Syntax


DWORD DhcpServerQueryAttribute(
  _In_   LPWSTR ServerIpAddr,
  _In_   ULONG dwReserved,
  _In_   DHCP_ATTRIB_ID DhcpAttribId,
  _Out_  LPDHCP_ATTRIB *pDhcpAttrib
);

Parameters

ServerIpAddr [in]

Unicode string that contains the IP address of the DHCP server.

dwReserved [in]

Reserved. This value must be zero.

DhcpAttribId [in]

DHCP_ATTRIB_ID value that specifies the particular DHCP server attribute to retrieve.

pDhcpAttrib [out]

Pointer to a DHCP_ATTRIB structure that contains the location and type of the queried DHCP server attribute.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Remarks

A DHCP server attribute is a value that can be queried to determine supported and available features.

Callers of this function should free the memory pointed to by pDhcpAttrib after use.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpServerQueryAttributes
DHCP_ATTRIB

 

 

Community Additions

ADD
Show:
© 2014 Microsoft