This function retrieves the name of the current user's private directory.
Context
Windows client,
Windows server,
Mobile client,
Mobile server,
Java client,
Java server,
Adelia Web client,
Adelia Cloud client.
Parameters
ALPHA(n) |
Path |
Variable receiving the name of the user's directory. |
NUM_BIN_4 |
PathLg |
Length of the Path variable. |
BOOL |
ReturnCode |
*TRUE if the operation was successful. Output parameter. |
Note on Mobile implementation:
Windows CE (Pocket PC implementation in particular) does not necessarily provide the notion of multi-user or associated private directory. In this case, the function returns an error code and the path is not entered.
Example
ALPHA(256) Path
NUM_BIN_4 PathLg
BOOL ReturnCode
PathLg = 256
CALL_DLL 'VATOOLBX.DLL' 'VaToolBxGetUserPrivateDirectory' Path PathLg ReturnCode
IF NOT ReturnCode
* Error processing...
END
List of the VaToolBx functions by topic