ClientHome Property  
 

Return the home directory for the active client session.

Syntax

object.ClientHome

Remarks

The ClientHome property returns the home directory for the active client session. This will be the same path to the home directory specified when the Authenticate method was used to authenticate the client session. If a home directory was not explicitly assigned when the client was authenticated, then this property returns the default home directory that was created for the client, or the server root directory if the MultiUser property was set to False when the server was started. The ClientDirectory property will return the current working directory for the client.

This property should only be accessed within an event handler after the client session has been authenticated. Unauthenticated clients are not assigned a home directory. This property will always return an empty string when accessed outside of an event handler.

Data Type

String

See Also

ClientDirectory Property, IsAuthenticated Property, MultiUser Property, Authenticate Method