dhcpcapi.h File Reference

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

Go to the source code of this file.

Functions
DWORD APIENTRY	DhcpLeaseIpAddress (DWORD AdapterIndex)
DWORD APIENTRY	DhcpQueryHWInfo (DWORD AdapterIndex, PDWORD MediaType, PDWORD Mtu, PDWORD Speed)
DWORD APIENTRY	DhcpReleaseIpAddressLease (DWORD AdapterIndex)
DWORD APIENTRY	DhcpRenewIpAddressLease (DWORD AdapterIndex)
DWORD APIENTRY	DhcpStaticRefreshParams (DWORD AdapterIndex, DWORD Address, DWORD Netmask)
DWORD APIENTRY	DhcpNotifyConfigChange (LPWSTR ServerName, LPWSTR AdapterName, BOOL NewIpAddress, DWORD IpIndex, DWORD IpAddress, DWORD SubnetMask, int DhcpAction)
DWORD APIENTRY	DhcpRosGetAdapterInfo (DWORD AdapterIndex, PBOOL DhcpEnabled, PDWORD DhcpServer, time_t *LeaseObtained, time_t *LeaseExpires)

Function Documentation

DhcpLeaseIpAddress()

DWORD APIENTRY DhcpLeaseIpAddress

(

DWORD

AdapterIndex

)

Definition at line 111 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqLeaseIpAddress;
    Req.AdapterIndex = AdapterIndex;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);
    if (!Result)
    {
        /* Pipe transaction failed */
        return 0;
    }

    return Reply.Reply;
}

DhcpNotifyConfigChange()

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

DhcpQueryHWInfo()

DWORD APIENTRY DhcpQueryHWInfo	(	DWORD	AdapterIndex,
		PDWORD	MediaType,
		PDWORD	Mtu,
		PDWORD	Speed
	)

Definition at line 76 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqQueryHWInfo;
    Req.AdapterIndex = AdapterIndex;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);
    if (!Result)
    {
        /* Pipe transaction failed */
        return 0;
    }

    if (Reply.Reply == 0)
        return 0;

    *MediaType = Reply.QueryHWInfo.MediaType;
    *Mtu = Reply.QueryHWInfo.Mtu;
    *Speed = Reply.QueryHWInfo.Speed;
    return 1;
}

DhcpReleaseIpAddressLease()

DWORD APIENTRY DhcpReleaseIpAddressLease

(

DWORD

AdapterIndex

)

Definition at line 137 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqReleaseIpAddress;
    Req.AdapterIndex = AdapterIndex;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);
    if (!Result)
    {
        /* Pipe transaction failed */
        return 0;
    }

    return Reply.Reply;
}

Referenced by IpReleaseAddress().

DhcpRenewIpAddressLease()

DWORD APIENTRY DhcpRenewIpAddressLease

(

DWORD

AdapterIndex

)

Definition at line 163 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqRenewIpAddress;
    Req.AdapterIndex = AdapterIndex;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);
    if (!Result)
    {
        /* Pipe transaction failed */
        return 0;
    }

    return Reply.Reply;
}

Referenced by IpRenewAddress().

DhcpRosGetAdapterInfo()

DWORD APIENTRY DhcpRosGetAdapterInfo	(	DWORD	AdapterIndex,
		PBOOL	DhcpEnabled,
		PDWORD	DhcpServer,
		time_t *	LeaseObtained,
		time_t *	LeaseExpires
	)

Get DHCP info for an adapter

Parameters

[in]	AdapterIndex	Index of the adapter (iphlpapi-style) for which info is requested
[out]	DhcpEnabled	Returns whether DHCP is enabled for the adapter
[out]	DhcpServer	Returns DHCP server IP address (255.255.255.255 if no server reached yet), in network byte order
[out]	LeaseObtained	Returns time at which the lease was obtained
[out]	LeaseExpires	Returns time at which the lease will expire

Returns

non-zero on success

Remarks

This is a ReactOS-only routine

Definition at line 298 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqGetAdapterInfo;
    Req.AdapterIndex = AdapterIndex;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);

    if (Result && Reply.Reply != 0)
        *DhcpEnabled = Reply.GetAdapterInfo.DhcpEnabled;
    else
        *DhcpEnabled = FALSE;

    if (*DhcpEnabled)
    {
        *DhcpServer = Reply.GetAdapterInfo.DhcpServer;
        *LeaseObtained = Reply.GetAdapterInfo.LeaseObtained;
        *LeaseExpires = Reply.GetAdapterInfo.LeaseExpires;
    }
    else
    {
        *DhcpServer = INADDR_NONE;
        *LeaseObtained = 0;
        *LeaseExpires = 0;
    }

    return Reply.Reply;
}

DhcpStaticRefreshParams()

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

Definition at line 189 of file dhcpcsvc.c.

{
    COMM_DHCP_REQ Req;
    COMM_DHCP_REPLY Reply;
    DWORD BytesRead;
    BOOL Result;

    ASSERT(PipeHandle != INVALID_HANDLE_VALUE);

    Req.Type = DhcpReqStaticRefreshParams;
    Req.AdapterIndex = AdapterIndex;
    Req.Body.StaticRefreshParams.IPAddress = Address;
    Req.Body.StaticRefreshParams.Netmask = Netmask;

    Result = TransactNamedPipe(PipeHandle,
                               &Req, sizeof(Req),
                               &Reply, sizeof(Reply),
                               &BytesRead, NULL);
    if (!Result)
    {
        /* Pipe transaction failed */
        return 0;
    }

    return Reply.Reply;
}

Referenced by INetCfgComponentControl_fnApplyRegistryChanges().