ZfxHoldMsg
Request server to suspend processing of message.
Syntax
ZFERR FAR ZfxHoldMsg( ZFSESSIONHANDLE hSession, ZFMSGDIR MsgDir, char FAR *lpszBody)
Parameters
Parameter |
Description |
hSession |
API session handle, as returned by ZfxAPI |
Init call |
MsgDirMessage type (ZFDIR_OUT) |
lpszBody |
Base name of message file |
Description
This routine is called to stop the server processing a message after it has been submitted using ZfxSendMsgEx. The routine sends a request to the Zetafax server, which processes it asynchronously.
Held messages remain in the queue in their original position until released or deleted. Any transmissions in progress when the hold request is received will not be interrupted, but no further preparation will take place and the message will not be submitted to any new devices for sending. Normal processing is resumed by calling the ZfxReleaseMsg function.
Return value
The routine returns 0 if successful, otherwise one of the following:
ZFERR_NOT_INITIALISED
ZFERR_INVALID_PARAMETERS
ZFERR_UNKNOWN_MESSAGE
ZFERR_SERVER_NOT_RUNNING
ZFERR_CANNOT_SUBMIT_REQUEST
Example
#include <stdio.h>
#include <zfapi.h>
...
if (ZfxHoldMsg(hSession, ZFDIR_OUT, "~XSND000") == 0)
{
printf("Message hold request sent\n");
/* Processing not stopped until status */
/* changes to ZFMSG_HELD */
...
}
Related topics