<< Click to Display Table of Contents >>

 

zetafax_logo

ZfxGetUserInDir

 


 

Get location of user's IN directory.

 

Syntax

 

ZFERR FAR ZfxGetUserInDir( ZFSESSIONHANDLE hSession, char FAR *lpszBuffer, short BufLen)

 

Parameters

 

Parameter

Description

hSession

API session handle, as returned by ZfxAPIInit call

lpszBuffer

Address 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 OUT directory, with a  backslash added (eg "S:\ZFAX\USERS\FRED\Z-OUT\"). The terminating backslash  means that a valid path can be formed by appending a file name to this string.

 

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 (ZfxGetUserInDir(hSession, szPath, sizeof(szPath)) == 0)

{

 ...

}

 

Related topics

Alphabetical reference

Function error returns and reference