diff --git a/lib/modules/Sql.pmod/sql_result.pike b/lib/modules/Sql.pmod/sql_result.pike index 42795852efe0dd7c73a1206bda0a6b83ac66d04a..7fe43129eb69fa8d549cfa694691ef5b3a4bc56b 100644 --- a/lib/modules/Sql.pmod/sql_result.pike +++ b/lib/modules/Sql.pmod/sql_result.pike @@ -1,5 +1,5 @@ /* - * $Id: sql_result.pike,v 1.23 2009/09/10 00:01:52 nilsson Exp $ + * $Id: sql_result.pike,v 1.24 2009/11/06 15:22:13 grubba Exp $ * * Implements the generic result module of the SQL-interface * @@ -65,7 +65,30 @@ void seek(int skip) { } //! Fetch the next row from the result. -int|array(string|int) fetch_row(); +//! +//! @returns +//! Returns an array with one element per field in +//! the same order as reported by @[fetch_fields()]. +//! The elements may be one of: +//! @mixed +//! @type zero|object(Sql.NULL) +//! @[UNDEFINED] or @[Sql.NULL] if the field is @tt{NULL@}. +//! @type string +//! A string containing the data for the field. +//! @type int +//! An int (possibly large) if generated by @[Sql.big_typed_query()] +//! or @[Sql.streaming_typed_query()] (aka @tt{TYPED@}-operation) +//! and the SQL field type was of an integer type. +//! @type float +//! A float if generated by @[Sql.big_typed_query()] or +//! @[Sql.streaming_typed_query()] (aka @tt{TYPED@}-operation) +//! and the SQL field type was of a floating-point type. +//! @endmixed +//! +//! @note +//! @tt{TYPED@}-operation was not supported at all prior to Pike 7.8.361, +//! and may not be supported for all databases. +int|array(string|int|float) fetch_row(); // --- Iterator API