Table of Contents Index NMS Glossary Previous Page Next Page (Page 9 of 15 in this chapter) Version


faxGetMessage

Description

Gets a message from the specified fax device.

Prototype

LONG faxGetMessage ( HFAX hFax,
FAXMESSAGE *faxmessage)

hFax Handle returned by TAPI.

faxmessage Pointer to the FAX_MESSAGE structure that receives the document status:

typedef struct 
{
 DWORD size;
 DWORD docnum;       /* Entry number in queue          */
 DWORD processedstatus;   /* Has this document been sent?             */
       /* FAX_NO, FAX_YES, or error          */
 DWORD lasterror;      /* Last error code (if any) for doc          */
 DWORD pagecount;       /* Number of pages (for receive)          */
 DWORD startpage;      /* Page to start at (for retransmit)          */
 DWORD lastpagesent;      /* Last page # successfully sent          */
 DWORD retranscount;      /* Number of retries          */
 DWORD docencoding;      /* 1D (MH) or 2D (MR) or MMR          */
 DWORD docresolution;       /* Resolution: low, high, superhigh          */
 DWORD docwidth;      /* Width: A4, A3, B4          */
 DWORD negotiatedencoding;
/* Encoding used for transfer */
DWORD negotiatedrate; /* Baud rate used for transfer */ DWORD negotiatedresolution;
/* Resolution used for transfer */
DWORD negotiatedwidth; /* Page width used for transfer */ DWORD badlinecount; /* Number of bad lines in doc rcvd; */ /* or, in ECM, bad frames txed/rxed */ DWORD doctime; /* Time document processing started */ DWORD duration; /* Seconds elapsed processing doc */ char filename[FAX_FILENAME_MAX]; /* Filename arg from FAXEnqueueDoc */ } FAX_DOC_STATUS;

Return Values

Events

Details

Use this function to get messages from events that result from using faxOpen.

For more information, refer to Section 7.8.1, Error Handling During a Fax Session.

See Also

faxOpen



Table of Contents Index NMS Glossary Previous Page Next Page (Page 9 of 15 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.