(Page 15 of 15 in this chapter) Version

nfxStopSession

Description

Stops a current send or receive operation.

Prototype

DWORD nfxStopSession ( CTAHD ctahd)
ctahd CTA context handle returned by ctaCreateContext.

Return Values

SUCCESS
CTAERR_BAD_ARGUMENTInvalid function argument passed.
CTAERR_FUNCTION_NOT_ACTIVEThere is no active fax function on the given CTA context.
CTAERR_INVALID_CTAHDThe specified CTA context handle is invalid.

Events

NFXEVN_SESSION_DONEThe fax session has completed with the terminating reason of CTA_REASON_STOPPED.

Details

After the application invokes nfxStopSession, NaturalFax immediately terminates the current send or receive operation. Cancellation is complete when the NFXEVN_SESSION_DONE event arrives.
This function should be used when the application encounters an unexpected error. The fax session terminates abruptly, and will not be completed with a T.30 DCN message. This function should also be used when the telephone call is terminated by the remote end and the application is not using ADI or ISDN Natural Call Control Interface (Layer 4) functions for call control. For example, when low layer ISDN protocols are used by the application, NaturalFax is not notified when the call is released. Therefore, the application must use nfxStopSession to terminate an active fax session.

See Also

nfxAnswerFaxPoll, nfxReceiveFax, nfxSendFax

(Page 15 of 15 in this chapter) Version

tech_support@nmss.com

Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.