ZfxGetUserArea
Get location of user's base directory.
Syntax
ZFERR FAR ZfxGetUserArea( ZFSESSIONHANDLE hSession, char FAR *lpszBuffer, short BufLen)
Parameters
Parameter |
Description |
hSession |
API session handle, as returned by ZfxAPIInit calllpszBufferAddress of buffer used to return the full path of the directory, including a terminating backslash ('\') and NULL. |
BufLen |
Size of the buffer (including space for the terminating NULL) |
Description
This routine returns the full path name of the user's base directory , with a backslash added to the end (eg "S:\ZFAX\USERS\FRED\"). The terminating backslash means that a valid path can be formed by appending a file name to this string. The directory should not normally be required by the API.
Return value
The routine returns 0 if successful, otherwise one of the following:
ZFERR_NOT_INITIALISED
ZFERR_BUFFER_TOO_SMALL
Example
#include <stdio.h>
#include <zfapi.h>
...
szPath[256];
if (ZfxGetUserArea(hSession, szPath, sizeof(szPath)) == 0) { ... }
Related topics