(Page 1 of 15 in this chapter) Version

Chapter 8

NaturalFax for TAPI Function Reference

This chapter provides a summary and a comprehensive description of each NaturalFax for TAPI function. Functions are listed in alphabetical order.

NaturalFax for TAPI provides functions to: Build and destroy document queues Transmit or receive faxes Monitor fax session status Monitor fax document status
This section groups NaturalFax for TAPI functions by the type of tasks they perform. The functions are grouped by: Functions that manage the fax device Functions that handle sending and receiving faxes Assisted functions, which manage the fax details

Function	S/A¹	Description
faxGetID	S	Returns the fax device ID.
faxOpen	S	Opens the specified fax device.
faxGetMessage	S	Gets a message from the fax device.
faxClose	S	Closes the fax device.

Function	S/A¹	Description
faxAnswerFaxPoll	A	Sends a fax in response to a poll.
faxCreateQueue	S	Creates a queue for fax documents.
faxDestroyQueue	S	Destroys a previously created queue.
faxEnqueueDoc	S	Queues a fax document.
faxGetDocStatus	S	Returns the status of document in a queue.
faxGetSessionStatus	S	Returns the status of a fax operation.
faxReceiveFax	A	Receives a fax and puts documents in a queue.
faxResetQueue	S	Resets documents in a queue to unsent.
faxSendFax	A	Sends all the documents in a queue.
faxStopSession	A	Stops an active fax session.

This section provides a comprehensive, alphabetically-ordered reference to the NaturalFax for TAPI functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function description includes: Prototype The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include: WORD DWORD INT16 INT32 BYTE 16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. Return Values The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS indicates the function was initiated. Subsequent events indicate the status of the operation. Errors and messages are returned by Windows, TAPI, and NaturalFax for TAPI. Events If events are listed, the function is asynchronous and is complete when the DONE event is returned. If there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the value field of the event. Events are returned by NaturalFax for TAPI.

Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
	WORD DWORD INT16 INT32 BYTE	16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined.
Return Values	The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS indicates the function was initiated. Subsequent events indicate the status of the operation. Errors and messages are returned by Windows, TAPI, and NaturalFax for TAPI.
Events	If events are listed, the function is asynchronous and is complete when the DONE event is returned. If there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the value field of the event. Events are returned by NaturalFax for TAPI.

(Page 1 of 15 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com