Deletes the specified document queue and frees the corresponding queue handle.
DWORD nfxDestroyQueue ( CTAHD ctahd, NFX_QUEUE_HANDLE queue_handle)
|
Argument |
Description |
|
ctahd |
Context handle returned by ctaCreateContext. |
|
queue_handle |
Identifies the queue to be freed. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
Invalid function argument passed. |
|
CTAERR_INVALID_CTAHD |
The specified context handle is invalid. |
|
CTAERR_INVALID_HANDLE |
The specified document queue handle is invalid. |
None.
This function deallocates the structures that maintain a document queue and deletes any remaining document entries in the designated document queue. After the application invokes nfxDestroyQueue, the specified queue handle is no longer valid for subsequent calls. The files identified by the queue structures are untouched.
The queue structure is deallocated also when ctaCloseServices is called.
Refer to Terminating and shutting down for more information.