Message transmission history
Details of the transmission history for a message in the CONTROL file may be obtained using the ZfxGetMsgHistoryEx routine, giving details of a single addressee or all addressees. This stores the information in a data structure of type ZFMSGHISTORYEX. The fields in this structure are as follows:
Below you will find details for:
Message transmission history Message event types Message routes
Field |
Description |
EventType |
Type of this record. This is a variable of type ZFMSGEVENT, and the value is one of the ZFEVENT_??? values listed below. |
Year |
Event timestamp (range 1980 to 2079) |
Month |
Event timestamp (range 1 to 12) |
Day |
Event timestamp (range 1 to 31) |
Hours |
Event timestamp (range 0 to 23) |
Mins |
Event timestamp (range 0 to 59) |
Secs |
Event timestamp (range 0 to 59) |
AddrNum |
Addressee number (starts from 1). When a single message has been addressed to more than one person, this allows the events to be identified. |
Route |
Route type used. This is a variable of type ZFMSGROUTE, and the value is one of the ZFROUTE_??? values listed below. |
szRouteParams |
Route parameters used. For fax routes this is the fax number dialled. The maximum length of this string (excluding terminating NULL) is given by the constant ZFDEV_PARAMS_LEN. |
ErrorCode |
Reason for failure. This is a variable of type ZFERR. The error code can be any of the L2ERR_??? values given in the file ZFERR.H - however note that the values depend on the version of the Zetafax server running, not the version of the API used. New versions of the server will have additional error codes. |
PagesSent |
Number of last page successfully sent (including the coversheet if used). If a three page message had several attempts at sending, but only the first two pages were sent successfully, this value would be set to 2. For event type ZFEVENT_SENT_OK this is the total number of pages in the message. |
ConnectSecs |
Connection time in seconds. This field only applies to events of type ZFEVENT_SENT_OK and ZFEVENT_SENT_ERROR, and gives the total connect time for the given addressee. |
szDevice |
The name of the device used to send the message. The maximum length of this string (excluding terminating NULL) is given by the constant ZFDEV_NAME_LEN. |
szRemoteServer |
The name of the remote server used to send the message via LCR. The maximum length of this string (excluding terminating NULL) is given by the constant ZFDEV_NAME_LEN. |
Message event types
The following list gives the possible event types for a message (variable of type ZFMSGEVENT).
Event |
Description |
ZFEVENT_SENT_OK |
Sent successfully |
ZFEVENT_RECD_OK |
Received successfully |
ZFEVENT_SCAN_OK |
Scanned successfully |
ZFEVENT_SENT_ERROR |
Sent with errors - the connection time and number of pages can be used to determine whether the error was during connection or transmission |
ZFEVENT_RECD_ERROR |
Received with errors. |
ZFEVENT_SCAN_ERROR |
Scanning request completed with errors. |
ZFEVENT_TRIED |
Send attempt unsuccessful. The Zetafax server makes several attempts to send to a given addressee. This event is logged if a send attempt is unsuccessful, but the server will retry later. If all attempts are unsuccessful, the last attempt will be logged as an event of type ZFEVENT_SENT_ERROR, while all previous events are logged as ZFEVENT_TRIED events. |
ZFEVENT_ROUTER_SUB |
Passed to remote Zetafax server for sending (when Least Cost Routing in use) |
ZFEVENT_ROUTER_ACC |
Accepted for transmission by remote server |
ZFEVENT_ROUTER_ERR |
Submission to a remote server failed |
Message routes
The following list gives the possible routes for fax messages (variable of type ZFMSGROUTE). Note that other routes are also supported by the Zetafax server, so this list is not exhaustive.
Route |
Description |
ZFROUTE_FAX_NORMAL |
Standard resolution fax (200 x 100 dpi) |
ZFROUTE_FAX_FINE |
Fine resolution fax (200 x 200 dpi) |
Related topics
Function error returns and reference