(Page 1 of 15 in this chapter)
Version
Chapter 7
NaturalFax Function Reference
7.1 Function Reference Introduction
nfxAnswerFaxPoll 85
nfxCheckTIFF 90
nfxConvertFileDirect 93
nfxCreateQueue 96
nfxDestroyQueue 98
nfxEnqueueDoc 99
nfxGetDocStatus 102
nfxGetSessionStatus 104
nfxMergeFile 106
nfxReceiveFax 108
nfxResetQueue 112
nfxSendFax 113
nfxSplitFile 120
nfxStopSession 122
7.1 Function Reference Introduction
This chapter provides a comprehensive, alphabetically-ordered reference to the NaturalFax 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 list of the function arguments. NMS 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. Refer to
Appendix B
for a description of all data structures and parameters.
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.
Refer to
Appendix A
for a list of all errors returned by NaturalFax functions.
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.
Refer to
Appendix A
for details about all NaturalFax events and reason codes.
(Page 1 of 15 in this chapter)
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights reserved.
(Page 1 of 15 in this chapter) Version
(Page 1 of 15 in this chapter) Version