dhcpcapi.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_DHCP_PNP_EVENT

Typedefs
typedef struct _DHCP_PNP_EVENT	DHCP_PNP_EVENT
typedef struct _DHCP_PNP_EVENT *	PDHCP_PNP_EVENT

Functions
DWORD APIENTRY	DhcpAcquireParameters (_In_ PWSTR AdapterName)
DWORD APIENTRY	DhcpAcquireParametersByBroadcast (_In_ PWSTR AdapterName)
DWORD APIENTRY	DhcpEnumClasses (_In_ DWORD Unknown1, _In_ PWSTR AdapterName, _In_ DWORD Unknown3, _In_ DWORD Unknown4)
DWORD APIENTRY	DhcpFallbackRefreshParams (_In_ PWSTR AdapterName)
DWORD APIENTRY	DhcpHandlePnPEvent (_In_ DWORD Unknown1, _In_ DWORD Unknown2, _In_ LPWSTR AdapterName, _In_ PDHCP_PNP_EVENT PnpEvent, _In_ DWORD Unknown5)
DWORD APIENTRY	DhcpNotifyConfigChange (_In_ LPWSTR ServerName, _In_ LPWSTR AdapterName, _In_ BOOL NewIpAddress, _In_ DWORD IpIndex, _In_ DWORD IpAddress, _In_ DWORD SubnetMask, _In_ INT DhcpAction)
DWORD APIENTRY	DhcpNotifyConfigChangeEx (_In_ LPWSTR ServerName, _In_ LPWSTR AdapterName, _In_ BOOL NewIpAddress, _In_ DWORD IpIndex, _In_ DWORD IpAddress, _In_ DWORD SubnetMask, _In_ INT DhcpAction, _In_ DWORD Unknown8)
DWORD APIENTRY	DhcpReleaseParameters (_In_ PWSTR AdapterName)
DWORD APIENTRY	DhcpStaticRefreshParams (DWORD AdapterIndex, DWORD Address, DWORD Netmask)

Typedef Documentation

DHCP_PNP_EVENT

typedef struct _DHCP_PNP_EVENT DHCP_PNP_EVENT

PDHCP_PNP_EVENT

typedef struct _DHCP_PNP_EVENT * PDHCP_PNP_EVENT

Function Documentation

DhcpAcquireParameters()

DWORD APIENTRY DhcpAcquireParameters

(

_In_ PWSTR

AdapterName

)

Renews a DHCP Lease

Parameters

[in]

AdapterName

Name (GUID) of the Adapter

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 243 of file dhcpcsvc.c.

{
    DWORD ret;
 
    DPRINT("DhcpAcquireParameters(%S)\n", AdapterName);
 
    RpcTryExcept
    {
        ret = Client_AcquireParameters(NULL, AdapterName);
    }
    RpcExcept(EXCEPTION_EXECUTE_HANDLER)
    {
        ret = I_RpcMapWin32Status(RpcExceptionCode());
    }
    RpcEndExcept;
 
    return ret;
}

Referenced by IpRenewAddress(), and Renew().

DhcpAcquireParametersByBroadcast()

DWORD APIENTRY DhcpAcquireParametersByBroadcast

(

_In_ PWSTR

AdapterName

)

Renews a DHCP Lease

Parameters

[in]

AdapterName

Name (GUID) of the Adapter

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 275 of file dhcpcsvc.c.

{
    DWORD ret;
 
    DPRINT("DhcpAcquireParametersByBroadcast(%S)\n", AdapterName);
 
    RpcTryExcept
    {
        ret = Client_AcquireParametersByBroadcast(NULL, AdapterName);
    }
    RpcExcept(EXCEPTION_EXECUTE_HANDLER)
    {
        ret = I_RpcMapWin32Status(RpcExceptionCode());
    }
    RpcEndExcept;
 
    return ret;
}

DhcpEnumClasses()

DWORD APIENTRY DhcpEnumClasses	(	_In_ DWORD	Unknown1,
		_In_ PWSTR	AdapterName,
		_In_ DWORD	Unknown3,
		_In_ DWORD	Unknown4
	)

Enumerates the DHCP user classes for the given adapter

Parameters

[in]	Unknown1	Unknown
[in]	AdapterName	Name (GUID) of the Adapter
[in]	Unknown3	Unknown
[in]	Unknown4	Unknown

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 316 of file dhcpcsvc.c.

{
    DPRINT1("DhcpEnumClasses(%lx %S %lx %lx)\n",
            Unknown1, AdapterName, Unknown3, Unknown4);
    return 0;
}

DhcpFallbackRefreshParams()

DWORD APIENTRY DhcpFallbackRefreshParams

(

_In_ PWSTR

AdapterName

)

Notify the DHCP client to refresh its fallback configuration

Parameters

[in]

AdapterName

Name (GUID) of the Adapter

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 339 of file dhcpcsvc.c.

{
    DWORD ret;
 
    DPRINT("DhcpFallbackRefreshParams(%S)\n", AdapterName);
 
    RpcTryExcept
    {
        ret = Client_FallbackRefreshParams(NULL, AdapterName);
    }
    RpcExcept(EXCEPTION_EXECUTE_HANDLER)
    {
        ret = I_RpcMapWin32Status(RpcExceptionCode());
    }
    RpcEndExcept;
 
    return ret;
}

DhcpHandlePnPEvent()

DWORD APIENTRY DhcpHandlePnPEvent	(	_In_ DWORD	Unknown1,
		_In_ DWORD	Unknown2,
		_In_ PWSTR	AdapterName,
		_In_ PDHCP_PNP_EVENT	PnpEvent,
		_In_ DWORD	Unknown5
	)

Notify the DHCP client of PNP events

Parameters

[in]	Unknown1	Unknown
[in]	Unknown2	Unknown
[in]	AdapterName	Name (GUID) of the Adapter
[in]	PnpEvent	Unknown
[in]	Unknown5	Unknown

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 383 of file dhcpcsvc.c.

{
    DWORD dwError = ERROR_SUCCESS;
 
    DPRINT1("DhcpHandlePnPEvent(%lx %lx %S %p %lx)\n",
            Unknown1, Unknown2, AdapterName, PnpEvent, Unknown5);
 
    if ((Unknown1 != 0) || (Unknown2 != 1) || (PnpEvent == NULL) || (Unknown5 != 0))
        return ERROR_INVALID_PARAMETER;
 
    if (PnpEvent->Unknown5)
    {
        dwError = SetBinaryClassId(AdapterName);
    }
 
    return dwError;
}

Referenced by SetClassId().

DhcpNotifyConfigChange()

DWORD APIENTRY DhcpNotifyConfigChange	(	_In_ LPWSTR	ServerName,
		_In_ LPWSTR	AdapterName,
		_In_ BOOL	NewIpAddress,
		_In_ DWORD	IpIndex,
		_In_ DWORD	IpAddress,
		_In_ DWORD	SubnetMask,
		_In_ INT	DhcpAction
	)

Set new TCP/IP parameters and notify DHCP client service of this

Parameters

[in]	ServerName	NULL for local machine
[in]	AdapterName	IPHLPAPI name of adapter to change
[in]	NewIpAddress	TRUE if IP address changes
[in]	IpIndex	...
[in]	IpAddress	New IP address (network byte order)
[in]	SubnetMask	New subnet mask (network byte order)
[in]	DhcpAction	0 - don't modify 1 - enable DHCP 2 - disable DHCP

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 438 of file dhcpcsvc.c.

{
    DPRINT("DhcpNotifyConfigChange(%S %S %lu %lu %lu %lu %d)\n",
           ServerName, AdapterName, NewIpAddress, IpIndex, IpAddress, SubnetMask, DhcpAction);
    return DhcpNotifyConfigChangeEx(ServerName, AdapterName, NewIpAddress,
                                    IpIndex, IpAddress, SubnetMask, DhcpAction, 0);
}

DhcpNotifyConfigChangeEx()

DWORD APIENTRY DhcpNotifyConfigChangeEx	(	_In_ LPWSTR	ServerName,
		_In_ LPWSTR	AdapterName,
		_In_ BOOL	NewIpAddress,
		_In_ DWORD	IpIndex,
		_In_ DWORD	IpAddress,
		_In_ DWORD	SubnetMask,
		_In_ INT	DhcpAction,
		_In_ DWORD	Unknown8
	)

Set new TCP/IP parameters and notify DHCP client service of this

Parameters

[in]	ServerName	NULL for local machine
[in]	AdapterName	IPHLPAPI name of adapter to change
[in]	NewIpAddress	TRUE if IP address changes
[in]	IpIndex	...
[in]	IpAddress	New IP address (network byte order)
[in]	SubnetMask	New subnet mask (network byte order)
[in]	DhcpAction	0 - don't modify 1 - enable DHCP 2 - disable DHCP
[in]	Unknown8	Unknown

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 488 of file dhcpcsvc.c.

{
    DWORD ret = ERROR_SUCCESS;
 
    DPRINT1("DHCPCSVC: DhcpNotifyConfigChangeEx not implemented yet\n");
    DPRINT1("DhcpNotifyConfigChangeEx(%S %S %lu %lu %lu %lu %d %lu)\n",
            ServerName, AdapterName, NewIpAddress, IpIndex, IpAddress, SubnetMask, DhcpAction, Unknown8);
 
    if (AdapterName == NULL)
        return ERROR_INVALID_PARAMETER;
 
    if (DhcpAction == 1) // Enable DHCP
    {
        if ((NewIpAddress != FALSE) ||
            (IpIndex != 0) ||
            (IpAddress != 0) ||
            (SubnetMask != 0))
            return ERROR_INVALID_PARAMETER;
    }
    else if (DhcpAction == 2) // Disable DHCP
    {
        if ((NewIpAddress == FALSE) ||
            (IpIndex != 0) ||
            (IpAddress == 0) ||
            (SubnetMask == 0))
            return ERROR_INVALID_PARAMETER;
    }
    else if (DhcpAction == 0) // Do not modify
    {
 
    }
    else
    {
        return ERROR_INVALID_PARAMETER;
    }
 
    if (DhcpAction == 1) // Enable DHCP
    {
        /* TODO: Remove static IP address(es) */
 
        RpcTryExcept
        {
            ret = Server_EnableDhcp(ServerName, AdapterName, TRUE);
        }
        RpcExcept(EXCEPTION_EXECUTE_HANDLER)
        {
            ret = I_RpcMapWin32Status(RpcExceptionCode());
        }
        RpcEndExcept;
    }
    else if (DhcpAction == 2) // Disable DHCP
    {
        RpcTryExcept
        {
            ret = Server_EnableDhcp(ServerName, AdapterName, FALSE);
        }
        RpcExcept(EXCEPTION_EXECUTE_HANDLER)
        {
            ret = I_RpcMapWin32Status(RpcExceptionCode());
        }
        RpcEndExcept;
    }
    else if (DhcpAction == 0) // Do not modify
    {
 
    }
 
    return ret;
}

Referenced by DhcpNotifyConfigChange().

DhcpReleaseParameters()

DWORD APIENTRY DhcpReleaseParameters

(

_In_ PWSTR

AdapterName

)

Releases a DHCP Lease

Parameters

[in]

AdapterName

Name (GUID) of the Adapter

Returns

ERROR_SUCCESS on success

Remarks

Undocumented by Microsoft

Definition at line 578 of file dhcpcsvc.c.

{
    DWORD ret;
 
    DPRINT("DhcpReleaseParameters(%S)\n", AdapterName);
 
    RpcTryExcept
    {
        ret = Client_ReleaseParameters(NULL, AdapterName);
    }
    RpcExcept(EXCEPTION_EXECUTE_HANDLER)
    {
        ret = I_RpcMapWin32Status(RpcExceptionCode());
    }
    RpcEndExcept;
 
    return ret;
}

Referenced by IpReleaseAddress(), and Release().

DhcpStaticRefreshParams()

DWORD APIENTRY DhcpStaticRefreshParams	(	DWORD	AdapterIndex,
		DWORD	Address,
		DWORD	Netmask
	)

Definition at line 626 of file dhcpcsvc.c.

{
    DWORD ret;
 
    DPRINT("DhcpStaticRefreshParams()\n");
 
    RpcTryExcept
    {
        ret = Client_StaticRefreshParams(NULL, AdapterIndex, Address, Netmask);
    }
    RpcExcept(EXCEPTION_EXECUTE_HANDLER)
    {
        ret = I_RpcMapWin32Status(RpcExceptionCode());
    }
    RpcEndExcept;
 
    return (ret == ERROR_SUCCESS) ? 1 : 0;
}

Referenced by INetCfgComponentControl_fnApplyPnpChanges().