(Page 18 of 18 in this chapter)

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 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 18 of 18 in this chapter)

tech_support@nmss.com

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