NFX_RECEIVE_PARMS

The NFX_RECEIVE_PARMS structure controls the behavior of fax reception, including the maximum data rate and the resolution accepted by the receiving fax terminal.

Dependent functions: nfxReceiveFax, nfxSendFax

Field name

Type

Units

Description

badlineaction

DWORD

None

The action that the receiving fax terminal takes upon receiving a bad line of image data. Values are:

  • NFX_BAD_LINE_ACTION_NONE: Causes the bad line to be stored in the image file.

  • NFX_BAD_LINE_ACTION_REPT: Repeats the previous line of image data (default).

  • NFX_BAD_LINE_ACTION_DROP: Discards the line.

  • NFX_BAD_LINE_ACTION_TICK: Adds a blank horizontal line with a tick mark in both margins.

encoding

DWORD

None

The maximum image encoding format capabilities to be advertised when receiving. NFX_ENCODE_1D causes all files to be stored in a format supported by all Group 3 fax terminals. The useECM parameter must be set to NFX_YES to use NFX_ENCODE_MMR.

NFX_ENCODE_TIFF_S causes the output file to be written using the TIFF-S specification. Values for the encoding, resolution, and pagewidth fields are overwritten with TIFF-S defaults of 1D encoding, low resolution, and A4 pagewidth.

Default: NFX_ENCODE_1D

level

INT32

tenths of dBm

The transmission level. Values are -150 to - 60. -150 corresponds to -15 dBm. -60 corresponds to -6 dBm.

Default: -135

lineerrors

DWORD

count

The threshold for bad lines, expressed as a percentage of lines received. If the percentage of bad lines is above this threshold, the receiver sends an RTN to request renegotiation with the transmitter. If this parameter is set to 100, NaturalFax never requests renegotiation. Values are 0 to 100.

Default: 5

minrate

DWORD

b/s

The minimum b/s rate to which the receiving fax terminal can negotiate. This parameter can be used to limit the range of rates used. Values are:

  • NFX_BIT_RATE_14400

  • NFX_BIT_RATE_12000

  • NFX_BIT_RATE_9600

  • NFX_BIT_RATE_7200

  • NFX_BIT_RATE_4800

  • NFX_BIT_RATE_2400 (default)

modemtype

DWORD

None

The maximum modem capabilities that are advertised when receiving a fax. Specifying a preferred modem sets an upper limit on the set of modems that NaturalFax advertises. AG and CG boards are capable of V.17 receive.

Modems support the following rates of data transmission:

  • V.27 ter supports 2400 and 4800 b/s.

  • V.29 supports 7200 and 9600 b/s.

  • V.17 supports 14400, 12000, 9600, and 7200 b/s.

Default: NFX_MODEM_TYPE_V29

NSF

BYTE

bytes

The value to be used in the non-standard facilities frame when receiving a fax. Values are a byte array between 0 and 54 bytes in length.

Default: NULL

NSFlength

DWORD

bytes

The length of the NSF field given in RECEIVE_PARMS.NSF. If this parameter is non-zero, the value in NSF is used when negotiating with the remote fax terminal. Values are 0 - 96.

Default: 0

OTFmode

DWORD

None

When to perform on-the-fly conversion during a fax receive operation. When receiving a fax, set to NFX_OTF_NEVER or NFX_OTF_ONLY_IF_FAIL to disable on-the-fly conversion and minimize CPU usage. Set to NFX_OTF_ALWAYS to always perform a conversion.

For more information, refer to Image conversion during fax reception.

Default: NFX_OTF_NEVER

pagewidth

DWORD

None

Values are:

  • NFX_PAGE_WIDTH_A4 (default)

  • NFX_PAGE_WIDTH_B4

  • NFX_PAGE_WIDTH_A3

pollingenabled

DWORD

None

Whether the receiver advertises the ability to respond to a poll request from the transmitting fax terminal.

Default: NFX_NO

resolution

DWORD

None

The maximum resolution to be advertised by receiving fax terminal. Values are:

  • NFX_RESOLUTION_HIGH (default)

  • NFX_RESOLUTION_LOW

  • NFX_RESOLUTION_SUPER_HIGH

rewindonRTN

DWORD

None

Receive: discard page if retrain requested.

Default: NFX_NO

SID

char

None

The subscriber ID to be used when receiving. The T.30 protocol recommends using the telephone number of the transmitting fax terminal. In the US, the FCC requires using the telephone number in the SID field when transmitting faxes. Values are a character string of 0 to 20 characters in length. The T.30 protocol allows only the digits 0 - 9, spaces, and [.] or [-].

Default: NULL

SUB

char

None

The sub-address string to be used when receiving. Values are a character string of 0 to 20 characters in length. The T.30 protocol allows only the digits 0 - 9, spaces, and * or #.

Default: NULL

threshold

INT32

tenths of dBm

The lowest signal level to be accepted by NaturalFax as a receiver. Values are -300 to -430. The -430 value corresponds to a minimum signal level of -43 dBm.

Default: -430

useECM

DWORD

None

Controls whether NaturalFax advertises error correction mode (ECM) capabilities as a receiver. If set to NFX_NO, ECM is not advertised.

Default: NFX_NO

useSUBADD

DWORD

None

Controls whether NaturalFax advertises SUB (sub-addressing) capabilities as a receiver. If set to NFX_NO, SUB is not advertised.

Default: NFX_YES