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
Download Visual Studio Add-In

NetDfsRemove (netapi32)
 
.
Summary
The NetDfsRemove function removes a target from a Distributed File System (Dfs) link. If the specified target is the last associated with the Dfs link, then the NetDfsRemove function also removes the link

C# Signature:

    /// <summary>
    /// The NetDfsRemove function removes a target from a Distributed File System (Dfs) link. If the specified target is the last associated with the Dfs link, then the NetDfsRemove function also removes the link.
    /// </summary>
    /// <param name="DfsEntryPath">[in] Pointer to a string that specifies the Universal Naming Convention path of a Dfs link in a named Dfs root. </param>
    /// <param name="ServerName">[in] Pointer to a string that specifies the name of the host server that the Dfs link references.</param>
    /// <param name="ShareName">[in] Pointer to a string that specifies the name of the shared folder or the path to a folder within a shared folder on the host server that the Dfs link references. </param>
    /// <returns>If the function succeeds, the return value is NERR_Success. If the function fails, the return value is a system error code</returns>
    [DllImport("Netapi32.dll", CharSet = CharSet.Auto, SetLastError = true)]
    static extern int NetDfsRemove(
      [MarshalAs(UnmanagedType.LPWStr)] string DfsEntryPath,
      [MarshalAs(UnmanagedType.LPWStr)] string ServerName,
      [MarshalAs(UnmanagedType.LPWStr)] string ShareName
    );

VB Signature:

    ''' <summary>
    ''' The NetDfsRemove function removes a target from a Distributed File System (Dfs) link. If the specified target is the last associated with the Dfs link, then the NetDfsRemove function also removes the link.
    ''' </summary>
    ''' <param name="DfsEntryPath">[in] Pointer to a string that specifies the Universal Naming Convention path of a Dfs link in a named Dfs root. </param>
    ''' <param name="ServerName">[in] Pointer to a string that specifies the name of the host server that the Dfs link references. Set this parameter to NULL if the link and all link targets are to be removed.</param>
    ''' <param name="ShareName">[in] Pointer to a string that specifies the name of the shared folder or the path to a folder within a shared folder on the host server that the Dfs link references. Set this parameter to NULL if the link and all link targets are to be removed.</param>
    ''' <returns>If the function succeeds, the return value is NERR_Success. If the function fails, the return value is a system error code</returns>

    Declare Function NetDfsRemove Lib "NETAPI32.DLL" (<Runtime.InteropServices.MarshalAs(Runtime.InteropServices.UnmanagedType.LPWStr)> _
  ByVal DfsEntryPath As String, <Runtime.InteropServices.MarshalAs(Runtime.InteropServices.UnmanagedType.LPWStr)> _
  ByVal ServerName As String, <Runtime.InteropServices.MarshalAs(Runtime.InteropServices.UnmanagedType.LPWStr)> _
  ByVal ShareName As String) As Long

User-Defined Types:

None.

Sample Code:

NetDfsRemove(DFSPath, ServerName, ShareName)

NetDfsRemove(DFSPAth, Servername, ShareName)

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

11/1/2013 - VB Signature added

Tips & Tricks:

Please add some!

Sample Code:

Please add some!

Documentation

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