Expand Minimize

DhcpGetClientInfo function

The DhcpGetClientInfo function returns information about a specific DHCP client.

Syntax


DWORD DHCP_API_FUNCTION DhcpGetClientInfo(
  _In_   DHCP_CONST WCHAR *ServerIpAddress,
  _In_   DHCP_CONST DHCP_SEARCH_INFO *SearchInfo,
  _Out_  LPDHCP_CLIENT_INFO *ClientInfo
);

Parameters

ServerIpAddress [in]

Unicode string that specifies the IP address or hostname of the DHCP server.

SearchInfo [in]

DHCP_SEARCH_INFO structure that contains the parameters for the search.

ClientInfo [out]

Pointer to a DHCP_CLIENT_INFO structure that contains information describing the DHCP client that most closely matches the provided search parameters. If no client is found, this parameter will be null.

Note  

The memory for this parameter must be free using DhcpRpcFreeMemory.

Return value

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

Remarks

This function requires host byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpSetClientInfo
DHCP_SEARCH_INFO
DHCP_CLIENT_INFO

 

 

Community Additions

ADD
Show:
© 2014 Microsoft