GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

AlphaToInteger Function

Overview

The AlphaToInteger function converts a string containing letter-style numbering (such as those commonly used in spreadsheet columns) to an integer value.

Syntax/Parameters

Syntax

int = AlphaToInteger ( string data );

Parameters

data

A string containing a letter sequence.

Return Value

Returns an int containing the integer equivalent of value or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The AlphaToInteger function is particularly useful when parsing data from spreadsheet applications, which commonly denote a column using letter notation or as a “cell address”. The conversion from letters to numbers is zero-inclusive such that ‘A’ becomes 0 and ‘AA’ becomes 26 and so forth. There is no equivalent to negative numbers for alphabetic numbers. Note that the numbering and lettering sequences in XDS and XFR files are incorrect and this routine cannot be used to convert between them.

If the string parameter cannot be converted to an integer, the GetLastError function will return ERROR_SYNTAX.

Related Functions

CellAddressGetColumn — Converts a cell address to index and returns the zero-based column value.

CellAddressGetRow — Converts a cell address to index and returns the zero-based row value.

CellAddressToIndex — Converts a cell address to index and returns row/column values as array.

CellIndexToAddress — Converts a zero-based row and column index to cell address.

CardinalToInteger — Converts a cardinal-style number to integer. For example: One 1, Eleven 11, 27, etc.

IntegerToCardinal — Converts an integer to cardinal-style numbering. For example: 1 One, 11 Eleven, etc.

IntegerToAlpha — Converts a numeric value to an alpha value. Zero-inclusive values, A 0, B 1, AA 26, AB 27, etc.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 04/22/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.