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
NetDfsGetClientInfo (netapi32)
 
.
Summary
The NetDfsGetClientInfo function retrieves information about a Distributed File System (Dfs) root or a link in the named Dfs root. The information represents the current computer's cached copy of the information about the Dfs link.

C# Signature:

[DllImport("Netapi32.dll", CharSet=CharSet.Unicode, SetLastError=true)]
    public static extern int NetDfsGetClientInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string DfsEntryPath,        // DFS entry path for the volume
    [MarshalAs(UnmanagedType.LPWStr)] string ServerName,        // This parameter is currently ignored and should be NULL
    [MarshalAs(UnmanagedType.LPWStr)] string ShareName,        // This parameter is currently ignored and should be NULL.
    int Level,                        // Level of information requested
    out IntPtr Buffer                        // API allocates and returns buffer with requested info
    );

VB Signature:

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

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

public static string GetActiveServer(string[] arguments)

{

    string ActiveOnlineServer = string.Empty;

    IntPtr buffer;
    DFS_STORAGE_INFO storage = new DFS_STORAGE_INFO();

    if (arguments.GetLength(0) != 1) return null;

    int result = NetDfsGetClientInfo(arguments[0], null, null, 3, out buffer);

    if (0 == result)
    {
        try
        {
            DFS_INFO_3 _infoLevel3 = (DFS_INFO_3) Marshal.PtrToStructure(buffer, typeof(DFS_INFO_3));

            IntPtr pStorage = new IntPtr(_infoLevel3.Storage.ToInt64() + 0 * Marshal.SizeOf(typeof(DFS_STORAGE_INFO)));
            storage = (DFS_STORAGE_INFO) Marshal.PtrToStructure(pStorage, typeof(DFS_STORAGE_INFO));

            if (storage.State == (DFS_STORAGE_STATE_ACTIVE | DFS_STORAGE_STATE_ONLINE)) ActiveOnlineServer = storage.ServerName;
        }
        finally
        {
            NetApiBufferFree(buffer);
        }
    }

    return ActiveOnlineServer.ToUpper();

}

public static string GetActiveServerAndShare(string[] arguments)

{

    string ServerShare = string.Empty;

    IntPtr buffer;
    DFS_STORAGE_INFO storage = new DFS_STORAGE_INFO();

    if (arguments.GetLength(0) != 1) return null;

    int result = NetDfsGetClientInfo(arguments[0], null, null, 3, out buffer);

    if (0 == result)
    {
        try
        {
            DFS_INFO_3 _infoLevel3 = (DFS_INFO_3) Marshal.PtrToStructure(buffer, typeof(DFS_INFO_3));

            IntPtr pStorage = new IntPtr(_infoLevel3.Storage.ToInt64() + 0 * Marshal.SizeOf(typeof(DFS_STORAGE_INFO)));
            storage = (DFS_STORAGE_INFO) Marshal.PtrToStructure(pStorage, typeof(DFS_STORAGE_INFO));

            if (storage.State == (DFS_STORAGE_STATE_ACTIVE | DFS_STORAGE_STATE_ONLINE))
                ServerShare = string.Format("\\\\{0}\\{1}", storage.ServerName.ToUpper(), storage.ShareName.ToUpper());
        }
        finally
        {
            NetApiBufferFree(buffer);
        }
    }

    return ServerShare;

}

Documentation
NetDfsGetClientInfo @msdn 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