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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

ODBCFetchArray Function

Overview

The ODBCFetchArray function returns the contents of the current row from an ODBC Results Object in the form of an array.

Syntax/Parameters

Syntax

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

Parameters

hResult

A handle for a ODBC Results Object.

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. The default value is FALSE.

Return Value

Returns an array of strings representing the next row or an empty array on failure. Use the GetLastError function to retrieve error information. The GetLastErrorMessage function may supply additional information.

Remarks

The ODBCFetchArray function returns the current row within the ODBC Results Object. The function also increments the internal position within the object so that a subsequent call to the ODBCFetchArray function will return the next row (or, in the case of the ODBCFetchData function, data from the next row). Because of this, the ODBCNextRow function should not be used in conjunction with this function. If a column within the ODBC Results Object is empty, the corresponding slot within the returned array will be loaded with an empty string. If there was an error or no data can be retrieved, the number of used elements in the array will be reset to zero.

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.

Related Functions

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

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

ODBCFetchAll — Returns all rows and columns 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.