(Page 2 of 18 in this chapter)


nfxAnswerFaxPoll

Description

Provides a send queue of documents to send in response to a poll request from the remote fax terminal.

Prototype

DWORD nfxAnswerFaxPoll ( CTAHD ctahd,
NFX_QUEUE_HANDLE send_queue_handle,
NFX_TRANSMIT_PARMS *ptr_transmit_parms)

ctahd CTA context handle returned by ctaCreateContext.

send_queue_handle Handle for queue of documents to send, returned by nfxCreateQueue.

ptr_transmit_parms Pointer to NFX_TRANSMIT_PARMS structure, (or NULL to use default values), as follows:

typedef struct 
{
  DWORD size;
 DWORD modemtype;   /* NFX_MODEM_TYPE_V17, NFX_MODEM_TYPE_V27,             */
     /* or NFX_MODEM_TYPE_V29             */
 DWORD minrate;     /* NFX_BIT_RATE_2400, NFX_BIT_RATE_4800,             */
     /* NFX_BIT_RATE_7200, or NFX_BIT_RATE_9600            */
 DWORD resolution;/* NFX_RESOLUTION_HIGH, NFX_RESOLUTION_LOW or                */
     /* NFX_RESOLUTION_SUPER_HIGH            */
 DWORD encoding;    /* NFX_ENCODE_1D, NFX_ENCODE_2D, NFX_ENCODE_MMR      */
 DWORD pagewidth;  /* NFX_PAGE_WIDTH_A4, NFX_PAGE_WIDTH__B4, or              */
      /* NFX_PAGE_WIDTH_A3            */
 DWORD OTFmode;     /* NFX_OTF_NEVER, NFX_OTF_ALWAYS,             */
     /* or NFX_OTF_ONLY_IF_FAIL            */
 DWORD useECM;     /* NFX_YES or NFX_NO            */
 DWORD useCNG;     /* NFX_YES or NFX_NO            */
 DWORD PRIenabled;/* NFX_YES or NFX_NO                */
 DWORD timeout;    /* number of seconds to wait for receiver            */
 DWORD retrainaction;
/* NFX_RTN_REPEAT_PAGE or NFX_RTN_NEXT_PAGE */
DWORD addheader; /* NFX_YES or NFX_NO */ INT32 level; /* transmit level in tenths of dBm (-150 to -60) */ INT32 threshold; /* lowest level for receive, in tenths of dBm */ DWORD NSFlength; /* length of NSF field or 0 if none */ char SID[NFX_MAX_SID]; /* Subscriber ID string */ BYTE NSF[NFX_MAX_NSF]; /* default NSF for session */ } NFX_TRANSMIT_PARMS;

Return Values

Events

Details

When NFXEVN_POLLED is received, nfxStopSession may be called to refuse the poll request from the called fax terminal.

Note: nfxAnswerFaxPoll must be called within three seconds of receiving NFXEVN_POLLED, which is the event that indicates a poll request. If nfxAnswerPoll is not called within three seconds, the fax session times out and the application receives an NFXEVN_SESSION_DONE event.

Receiving any of the events listed above indicates that the fax session status has been updated. Use nfxGetSessionStatus to examine the current session status in more detail when any of the information events are received.

Using Fax Headers

The addheader parameter in the NFX_TRANSMIT_PARMS structure indicates whether headers are added to the transmitted image data. The header is a fixed string in the following format:

FROM: transmit_SID Date Time Page N of M

By default, addheader is set to NFX_YES, and a header is added to the document being transmitted.
WARNING:

Headers are mandated in certain countries, including those under FCC or DoC jurisdiction. Check telecommunications regulations in the target countries for your fax application.

If the environment variable NFXHEADERFONT is not defined, no header is added, regardless of the value of addheader. See the NaturalFax Installation Manual for details.

See Also

nfxGetSessionStatus, nfxReceiveFax



(Page 2 of 18 in this chapter)


tech_support@nmss.com
Copyright © 1998, Natural MicroSystems, Inc. All rights reserved.