Cicode Programming Reference > Cicode Function Categories > Task Functions Introduction > QueClose

QueClose

Closes a queue opened with the QueOpen() function. All data is flushed from the queue.

If a Cicode task is waiting on the QueRead() function, it returns with a "queue empty" status. You should close all queues when they are no longer required, because they consume memory. At shutdown, CitectSCADA closes all open queues.

Syntax

QueClose(hQue)

hQue:

The queue handle, returned from the QueOpen() function. The queue handle identifies the table where all data on the associated queue is stored.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

QueLength, QueOpen, QueRead, QueWrite, QuePeek

Example

hQue=QueOpen("MyQue",1);
...
QueClose(hQue);

See Also

Task Functions