P/Invoke DhcpEnumServers from C#

As the first part of our DHCP management API series the following shows the sample code for enumerating authorised DHCP servers in the Active Directory domain.

This method runs on the machine where the code is running (not any DHCP server) therefore the caller machine must be connected to Active Directory.

/// <summary>
/// The DhcpEnumServers function returns an enumerated list of DHCP servers found in the directory service
/// </summary>
/// <remarks>http://msdn.microsoft.com/en-us/library/windows/desktop/aa813375(v=vs.85).aspx</remarks>
[DllImport("dhcpsapi.dll", SetLastError = true, CharSet = CharSet.Unicode)]
protected static extern uint DhcpEnumServers(
    uint Flags,
    IntPtr IdInfo,
    out IntPtr Servers,
    IntPtr CallbackFn,
    IntPtr CallbackData
);


 
/// <summary>
/// Returns an enumerated list of DHCP servers found in the Active Directory service
/// </summary>
public static List<String> GetAuthorisedServerNames()
{
    List<String> Servers = new List<String>();
    IntPtr EnumInfo;
    uint ReturnValue = DhcpEnumServers(0, IntPtr.Zero, out EnumInfo, IntPtr.Zero, IntPtr.Zero);
    TestReturnValue(ReturnValue);
    DHCP_SERVER_INFO_ARRAY ServerInfoArray = (DHCP_SERVER_INFO_ARRAY)Marshal.PtrToStructure(EnumInfo, typeof(DHCP_SERVER_INFO_ARRAY));
    int ArraySize = (int)ServerInfoArray.NumElements;
    IntPtr ServersArray = ServerInfoArray.Servers;
    IntPtr CurrentPointer = ServersArray;
    for (int i = 0; i < ArraySize; i++)
    {
        DHCPDS_SERVER CurrentServer = new DHCPDS_SERVER();
        Marshal.PtrToStructure(CurrentPointer, CurrentServer);
        Marshal.DestroyStructure(CurrentPointer, typeof(DHCPDS_SERVER));
        CurrentPointer = (IntPtr)((int)CurrentPointer + Marshal.SizeOf(CurrentServer));
        Servers.Add(CurrentServer.ServerName);
    }
    Marshal.FreeCoTaskMem(ServersArray);
    DhcpRpcFreeMemory(EnumInfo);
    Servers.Sort();
    return Servers;
}


/// <summary>
/// The DHCPDS_SERVERS structure defines a list of DHCP servers in the context of directory services.
/// </summary>
/// <remarks>http://msdn.microsoft.com/en-us/library/windows/desktop/aa813374(v=vs.85).aspx</remarks>
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public class DHCP_SERVER_INFO_ARRAY
{

    /// <summary>
    /// Reserved. This value should be 0.
    /// </summary>
    public uint Flags;

    /// <summary>
    /// Specifies the number of elements in Servers.
    /// </summary>
    public uint NumElements;

    /// <summary>
    /// Pointer to an array of DHCPDS_SERVER structures that contain information on individual DHCP servers.
    /// </summary>
    public IntPtr Servers;

}


/// <summary>
/// The DHCPDS_SERVER structure defines information on a DHCP server in the context of directory services.
/// </summary>
/// <remarks>http://msdn.microsoft.com/en-us/library/windows/desktop/aa813373(v=vs.85).aspx</remarks>
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public class DHCPDS_SERVER
{

    /// <summary>
    /// Reserved. This value should be set to 0.
    /// </summary>
    public uint Version;

    /// <summary>
    /// Unicode string that contains the unique name of the DHCP server.
    /// </summary>
    public String ServerName;

    /// <summary>
    /// Specifies the IP address of the DHCP server as an unsigned 32-bit integer.
    /// </summary>
    public uint ServerAddress;

    /// <summary>
    /// Specifies a set of bit flags that describe active directory settings for the DHCP server.
    /// </summary>
    public uint Flags;

    /// <summary>
    /// Reserved. This value should be set to 0.
    /// </summary>
    public uint State;

    /// <summary>
    /// Unicode string that contains the active directory path to the DHCP server.
    /// </summary>
    public String DsLocation;

    /// <summary>
    /// Reserved. This value should be set to 0.
    /// </summary>
    public uint DsLocType;

}


Comments

Post a Comment

Popular posts from this blog

Windows Server 2016, 2019, 2022, Windows 10 and Windows 11: Date and time "Some settings are managed by your organization".

Image
When you're using the new "Modern" date and time settings in Windows Server 2016, 2019, 2022, Windows 10 and Windows 11 you may find that you can't set the correct date and time and the value "Some settings are managed by your organization". - While you're here - Why not check out our Windows Server Documentation and Audit Tool? The simplest way around this is to go back to the proper control panel using Start, Run, "Control.exe" and searching for "Set the date".  Within here you can set the date and time manually as required If you try and click the Change time zone button you may again get access denied... To resolve this open an elevated command prompt by right clicking the command prompt and selecting Run as Administrator  From there run the command rundll32.exe shell32.dll,Control_RunDLL timedate.cpl This will open the Data and Time control panel app elevated as an Administrator.
Read more

TFTPD32 or TFTPD64 reports Bind error 10013 An attempt was made to access a socket in a way forbidden by its access permissions.

Image
When you start the trivial FTP (TFTP) server application TFTPD32 or TDTPD64 you may see the following error Bind error 10013 An attempt was made to access a socket in a way forbidden by its access permissions. This can be because another application is using this port. The easiest way to check if (and which) application is using the port is as administrator run an elevated command prompt and enter netstat -anb > ports.txt Then open ports.txt in Notepad and search for :69, you'll quickly be able to see the process using the required port - While you're here - Why not check out our Windows Server Documentation and Audit Tool?
Read more

Enable function lock for F1-F12 on HP ZBook mobile workstations

Image
When you press the function keys on a HP ZBook mobile workstation you may find that they don't operate as expected. This is because of function lock, if you hold the fn key the function keys work as expected. You can lock the function keys on as described in this document. https://support.hp.com/gb-en/document/c02035108 However there are two things to note Firstly following a BIOS upgrade (which occurs automatically if you have the preinstalled HP software still installed) you may lose your locked function keys and have to reapply.   Secondly the HP documentation states you press the fn lock and fn keys at the same time as per the image below from the page.  While you're here - Why not check out our Windows Server Documentation and Audit Tool? This is not the case, you need to press and hold the fn key, and then tap the fn lock key to toggle function lock, not an obvious thing when you start work first thing in the morning and are hammering the function keys try
Read more