(Page 3 of 19 in this chapter)

nfxAllocLicense

Description

This function attempts to reserve a fax license unit for online fax operations.

Prototype

DWORD nfxAllocLicense (CTAHD ctahd)
ctahd Handle returned by ctaCreateContext

Return Values

SUCCESSThe function completed successfully.
CTAERR_BAD_ARGUMENTInvalid function argument passed.
CTAERR_INVALID_CTAHDThe specified CTA context handle is invalid.
NFXERR_LICENSE_ALREADY_ALLOCA fax license unit is already allocated to this CTA context.
NFXERR_NO_MORE_LICENSES
There are no available fax license units.

Events

None.

Details

Explicit license allocation guarantees that the send or receive functions cannot fail due to implicit allocation when a license unit is not available. A fax license unit is not required for conversions or document queue manipulation.
If nfxAllocLicense is successful, the fax license unit is retained until either nfxReleaseLicense is called or until the CTA context is destroyed. The fax license unit is retained at the completion of fax send or fax receive operations.

See Also

nfxGetLicenseStatus, nfxReleaseLicense

(Page 3 of 19 in this chapter)

tech_support@nmss.com

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