(Page 8 of 19 in this chapter)

nfxDestroyQueue

Description

This function deletes the specified document queue and frees the corresponding queue handle.

Prototype

DWORD nfxDestroyQueue ( CTAHD ctahd,
NFX_QUEUE_HANDLE queue_handle)
ctahd Handle returned by ctaCreateContext
queue_handle Identifies the queue to be freed

Return Values

SUCCESSThe function completed successfully.
CTAERR_BAD_ARGUMENTInvalid function argument passed.
CTAERR_INVALID_CTAHDThe specified CTA context handle is invalid.
CTAERR_INVALID_HANDLEThe specified document queue handle is invalid.

Events

None.

Details

This function deallocates structures for maintaining both the queue and any remaining document entries in the queue. After this call, the queue handle is no longer valid for subsequent calls. Note: The files identified by the queue structures are untouched.
The queue structure is also deallocated when ctaCloseServices is called.

See Also

nfxCreateQueue, nfxEnqueueDoc

(Page 8 of 19 in this chapter)

tech_support@nmss.com

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