ZfxAbortMsg
Gets the default message settings for the user.
Syntax
ZFERR FAR ZfxAbortMsg( ZFSESSIONHANDLE hSession, ZFMSGDIR MsgDir, char FAR *lpszBody)
Parameters
Parameter |
Description |
Hsession |
API session handle, as returned by ZfxAPIInit call |
MsgDir |
Message type (ZFDIR_OUT) |
lpszBodyBase |
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. The routine can be called even if the server has already finished processing the message.
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 (ZfxAbortMsg(hSession, ZFDIR_OUT, "~XSND000") == 0)
{
printf("Message aborted\n");
/* now wait for status to change to */
/* ZFMSG_OK or ZFMSG_FAILED before */
/* deleting the message */
...
}
Related topics