GetHomeDirectory()

Syntax

Result$ = GetHomeDirectory()

Returns the home directory path of the currently logged user.

Parameters

None.

Return value

Returns the full path of the home directory. It will end with a directory separator ('\', #PS, #PS$ for Windows or '/', #NPS, #NPS$ otherwise).

It's very unlikely, but if this function fails, it will return an empty string.

Remarks

The home directory is the directory for the user data (preferences, plugins etc.) of the current user. Read and write access should be possible in this directory.

See Also

GetCurrentDirectory(), GetTemporaryDirectory(), GetUserDirectory()

Supported OS

All