Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
DsGetDcNext (netapi32)
 
.
Summary
The DsGetDcNext function retrieves the next domain controller in a domain controller enumeration operation.

C# Signature:

using HANDLE = System.IntPtr;
using DWORD = System.UInt32;

[DllImport("netapi32.dll", SetLastError=true)]
internal static extern DWORD DsGetDcNext(
     HANDLE GetDcContextHandle,
     IntPtr SockAddressCount,
     IntPtr SockAddresses, //must free this if using (SocketAddressCount > 1)
     out IntPtr DnsHostName //will have to marshal this one manually
     );

For Example #2 Below:

[DllImport("Netapi32.dll", EntryPoint = "DsGetDcNextW", CallingConvention = CallingConvention.StdCall, CharSet = CharSet.Unicode)]
internal static extern int DsGetDcNext([In] IntPtr getDcContextHandle,
    [In, Out] ref IntPtr sockAddressCount,
    out IntPtr sockAdresses, out IntPtr dnsHostName);

VB Signature:

Declare Function DsGetDcNext Lib "netapi32.dll" (TODO) As TODO

User-Defined Types:

None.

Notes:

GetDcContextHandle

in Contains the domain controller enumeration context handle provided by the DsGetDcOpen function.

SockAddressCount

[out, optional] Pointer to a ULONG value that receives the number of elements in the SockAddresses array. If this parameter is NULL, socket addresses are not retrieved.

SockAddresses

[out, optional] Pointer to an array of SOCKET_ADDRESS structures that receives the socket address data for the domain controller. SockAddressCount receives the number of elements in this array.

All returned addresses will be of type AF_INET or AF_INET6. The sin_port member contains the port from the server record. A port of 0 indicates no port is available from DNS.

The caller must free this memory when it is no longer required by calling LocalFree.

This parameter is ignored if SockAddressCount is NULL.

DnsHostName

[out, optional] Pointer to a string pointer that receives the DNS name of the domain controller. This parameter receives NULL if no host name is known. The caller must free this memory when it is no longer required by calling NetApiBufferFree.

Tips & Tricks:

Please add some!

Sample Code:

bool endLoop = false;
ArrayList al = new ArrayList();

while (!endLoop)
{
     IntPtr pDnsHostName = IntPtr.Zero;

     try
     {
     DWORD rc = NativeMethods.DsGetDcNext(
         pDcContext,
         IntPtr.Zero,
         IntPtr.Zero,
         out pDnsHostName
         );

     //check the return code
     switch (rc)
     {
         case 259: //ERROR_NO_MORE_ITEMS
         endLoop = true;
         break;
         case 0: //ERROR_SUCCESS
         al.Add(Marshal.PtrToStringAuto(pDnsHostName));
         break;
         case ERROR_FILEMARK_DETECTED: //127 - I think...
         break;
         default:
         throw new Win32Exception(); //internally calls GetLastWin32Error()
         break;
     }        
     }
     finally
     {
     if (!Win32.IsNullHandle(pDnsHostName)) //pNnsHostName != IntPtr.Zero;
         NativeMethods.NetApiBufferFree(pDnsHostName);
     }
}    

Example #2

    bool endLoop = false;
    IntPtr pDcContext = new IntPtr();

    int iReturn = 0;

    try
    {
        Console.WriteLine("Open");

        // leave the second parameter set to 0 and "MYADSITE" set to null if you want the entire domain
        iReturn = DsGetDcOpen("domain1.mydomains.com", 1, "MYADSITE", (System.IntPtr)null, null, 0, out pDcContext);

        Console.WriteLine("Enum " + iReturn.ToString());

        IntPtr pDnsHostName = IntPtr.Zero;
        while (!endLoop)
        {
            pDnsHostName = IntPtr.Zero;

            IntPtr ptr1 = IntPtr.Zero;
            IntPtr ptr2 = IntPtr.Zero;
            try
            {
                int rc = DsGetDcNext(pDcContext,ref ptr1,out ptr2,out pDnsHostName);

                string strHost = Marshal.PtrToStringUni(pDnsHostName);

                if (strHost == null)
                {
                    endLoop = true;
                }
                else
                {
                    Console.WriteLine(strHost);
                }
            }
            catch (Exception e)
            {
                Console.WriteLine("Ex: " + e.Message);
            }
        }
        NetApiBufferFree(pDnsHostName);
        DsGetDcClose(pDcContext);

    }
    catch(Exception e)
    {
        Console.WriteLine("Ex: " + e.Message);
    }

Alternative Managed API:

Do you know one? Please contribute it!

Documentation
DsGetDcNext on MSDN

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions