GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

ODBCFetchAll Function

Overview

The ODBCFetchAll function copies the entire data set from the ODBC Results object to a two-dimensional array.

Syntax/Parameters

Syntax

string[][] = ODBCFetchAll ( handle hResult, [boolean names] ) ;

Parameters

hResult

A handle value for a Result object from a successful ODBCQuery function call.

names

An option boolean flag indicating whether to add the column names (key names) to the array. Note that Legato allows key names of up to 64 characters.

Return Value

Returns a two-dimensional array of strings representing rows and columns or an empty array on failure. Use the GetLastError function to retrieve error information. The GetLastErrorMessage function may supply additional information.

Remarks

The ODBCFetchAll function should be called immediately after the ODBCQuery function. Data is retrieved from the current SQL cursor position so if any operations that read data are performed prior to this call, the data retrieval will start at that point.

If requested, the column names are saved as key names for the second dimension of the returned array. The column names must comply with Legato key name syntax and size. If the columns names are too large to be key names, use the ODBCFetchColumnName or ODBCFetchColumnNames function to retrieve the name values.

Related Functions

ODBCFetchColumnName — Gets the name of a specified column by position.

ODBCFetchColumnNames — Gets the names of all columns in the Result Object.

ODBCFetchArray — Returns all columns for the current row from the request as represented by the handle.

ODBCFetchBinary — Returns a handle to a Data Object for a column that has 'blob' type data.

ODBCFetchData — Returns the data for a specific column of the current row.

ODBCNextRow — Moves internally to the next row within the Result Object.

ODBCQuery — Performs a structured query based on the connection handle and query string.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.