<< Click to Display Table of Contents >>
ZfxGetMsgDefaultsEx
Gets the default message settings for the user.
Syntax
ZFERR FAR ZfxGetMsgDefaultsEx( ZFSESSIONHANDLE hSession, short MsgDefaultsExSize, ZFMSGDEFAULTSEX *lpMsgDefaultsEx)
Parameters
Parameter |
Description |
Hsession |
API session handle, as returned by ZfxAPIInit call MsgDefaultsExSize Size of ZFMSGDEFAULTSEX structure. Must be the size (in bytes) of a ZFMSGDEFAULTSEX structure |
lpMsgDefaultsEx |
Pointer to memory allocated for a ZFMSGDEFAULTSEX structure |
Description
This routine is called to get the default message settings for the Zetafax user associated with the API session associsted with the passed session handle.
Return value
The routine returns 0 if successful, otherwise one of the following:
ZFERR_NOT_INITIALISED
ZFERR_INVALID_PARAMETERS
Example
#include <stdio.h>
#include <zfapi.h>
...
ZFMSGDEFAULTSEX ZfMsgDefaults;
memset(&ZfMsgDefaults, (int) 0, sizeof(ZFMSGDEFAULTSEX)
if (ZfxGetMsgDefaultsEx(hSession, sizeof(ZFMSGDEFAULTSEX), &ZfMsgDefaults) == 0)
{
/* 'ZfMsgDefaults' structure now */
/* contains the default message */
/* settings for the user */
printf("Default message priority is %d\n", ZfMsgDefaults.Priority); ...
}
Related topics