DbPoll: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Server function}} {{New feature|3.0120|1.2| '''Available only in MTA SA 1.1.1 r3328 and onwards''' }} This function checks the progress of a database query. ==Synta...") |
No edit summary |
||
| Line 13: | Line 13: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''queryHandle:''' A query handle previously returned from [[dbQuery]] | *'''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 | *'''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=== | ===Returns=== | ||
Revision as of 17:54, 26 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 handle is incorrect.
- 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