IFtpHomeDirectoryProvider.GetUserHomeDirectoryData Method

IIS 7.0
 

Returns the physical path of the home directory for a user.

string GetUserHomeDirectoryData(  
   string sessionId,  
   string siteName,  
   string userName  
)  

Parameter NameDescription
sessionIdA string that contains the session ID.
siteNameA string that contains the site name.
userNameA string that contains the user name.

A string that contains the physical home directory information.

The following code example illustrates using the IFtpHomeDirectoryProvider interface to create a custom home directory module for the FTP service that returns a specific home directory.

using System;  
using Microsoft.Web.FtpServer;  
  
namespace FtpHomeDirectory  
{  
   public class FtpHomeDirDemo : BaseProvider,  
      IFtpHomeDirectoryProvider  
   {  
      string IFtpHomeDirectoryProvider.GetUserHomeDirectoryData(  
         string sessionId,  
         string siteName,  
         string userName)  
      {  
         // Note: You would add your own custom logic here.  
         // Return the user's home directory based on their user name.  
         return @"C:\Ftpusers\" + userName;  
      }  
   }  
}  

For an additional example, see How to Use Managed Code (C#) to Create a Simple FTP Home Directory Provider.

TypeDescription
Client- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016 Technical Preview
Product- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
ReferenceMicrosoft.Web.FtpServer.dll

IFtpHomeDirectoryProvider Interface

Show: