(Page 19 of 19 in this chapter)

nfxStopSession

Description

This function stops a current send or receive operation.

Prototype

DWORD nfxStopSession (CTAHD ctahd)
ctahd Handle returned by ctaCreateContext

Return Values

SUCCESS
The function completed successfully.
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 NFX_REASON_STOPPED.

Details

NaturalFax will complete sending or receiving a currently active page before cancelling the fax operation. Cancellation is complete when the NFXEVN_SESSION_DONE event arrives. The send or receive operation is terminated immediately.
If the fax operation that is being cancelled had implicitly allocated a fax license unit, that license unit is released.

See Also

nfxAnswerFaxPoll, nfxReceiveFax, nfxSendFax

(Page 19 of 19 in this chapter)

tech_support@nmss.com

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