IFtpHomeDirectoryProvider.GetUserHomeDirectoryData Method
Returns the physical path of the home directory for a user.
Syntax
string GetUserHomeDirectoryData(
string sessionId,
string siteName,
string userName
)
Function GetUserHomeDirectoryData(
ByVal sessionId As String,
ByVal siteName As String,
ByVal userName As String
) As String
Parameters
| Parameter Name | Description |
|---|---|
sessionId |
A string that contains the session ID. |
siteName |
A string that contains the site name. |
userName |
A string that contains the user name. |
Return Value
A string that contains the physical home directory information.
Example
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.
Requirements
| Type | Description |
|---|---|
| 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 |
| Reference | Microsoft.Web.FtpServer.dll |