DbPoll: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
===Returns=== | ===Returns=== | ||
*''nil:'' Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call [[dbFree]]) | *''nil:'' Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call [[dbFree]]) | ||
*''false:'' Returns false if the query handle is incorrect. | *''false:'' Returns false if the query string contained an error, the connection has been lost or the query handle is incorrect. This automatically frees the query handle, so you do not have to call [[dbFree]]. | ||
*''table:'' Returns a table when the results are ready. This automatically frees the query handle, so you do not have to call [[dbFree]]. | *''table:'' Returns a table when the results are ready. This automatically frees the query handle, so you do not have to call [[dbFree]]. | ||
Revision as of 04:08, 28 October 2011
Available only in MTA SA 1.1.1 r3328 and onwards This function checks the progress of a database query.
Syntax
table dbPoll ( handle queryHandle, int timeout )
Required Arguments
- queryHandle: A query handle previously returned from dbQuery
- timeout: How many milliseconds to wait for a result. Use 0 for and instant response (which may return nil). Use -1 to wait until a result is ready. Note: A wait here will freeze the entire server just like the executeSQL* functions
Returns
- nil: Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call dbFree)
- false: Returns false if the query string contained an error, the connection has been lost or the query handle is incorrect. This automatically frees the query handle, so you do not have to call dbFree.
- table: Returns a table when the results are ready. This automatically frees the query handle, so you do not have to call dbFree.
Example
This example waits until a result is ready
local result = dbPoll ( qh, -1 )
Requirements
This template will be deleted.
See Also