SQLRetrieveFlush

Syntax

SQLRetrieveFlush(ConnectNum)

Remarks

Flushes the current query and frees any resources held. In general, data from old queries is flushed when a new query is established, but you can use SQLRetrieveFlush to deliberately remove current query results. To use SQLRetrieveFlush, a macro must have already established a connection using SQLOpen. Also, a query must already have been executed using SQLExecQuery or SQLQueryExec, and results must be pending.

Argument

Explanation

ConnectNum

The unique connection ID for a data source. The data source specified must have pending query results. If ConnectNum is not valid, SQLExecQuery or SQLQueryExec would have returned an error value. In such a case, SQLRetrieveFlush places error information in memory for the error functions, if such information is available.


If the current query could not be flushed, the SQLErrorFlush function returns
a negative error value.