  |
GoFiler Legato Script Reference
Legato v 1.6k Application v 6.6a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
ImportColumnMapQuery Function‡
Overview
The ImportColumnMapQuery function allows a column map to be created by the user to link incoming data columns to an existing table format.
‡ Function is under construction.
Syntax/Parameters
Syntax
string [][] = ImportColumnMapQuery ( string caption, handle source,
string map[][],
[dword
flags], [int help_id],
[string
description] );
Parameters
caption
A string to be used as the caption for the dialog.
source
A handle to a Data Table or Data Sheet object.
map
An string specifying a qualified filename or source data..
flags
A optional dword specifying control flags to modify the behavior of the document.
help_id
An optional int specifying a help ID related to the dialog. [not sure how this works, may need to be a URL]
description
An optional string description for the dialog. This initially appears in the description area of the dialog.
Return Value
A string table containing the return column map or an empty array on failure. Use the GetLastError function to retrieve a formatted error code. This would normally be ERROR_CANCEL if the user presses cancel or another error based on the processing of the function.
If there the map fails initial validation, the function will return ERROR_SYNTAX. Use the GetLastErrorMessage to retrieve details as to which field has the issue.
Remarks
The map is prepared by the caller and the returned with the mapped positions as part of the map. The column key names are as follows:
| Key Name | Description | ||||
| Input Data | |||||
| id | Column id for the destination. Required field, this becomes the matching id for the column in the destination list. | ||||
| name | An optional friendly name for the destination columns. | ||||
| description | An optional description for the column. This can help the user map the data. [Appears at the bottom of the dialog when the column is selected. | ||||
| pattern | An optional [regex] matching pattern string for auto mapping. | ||||
| data_type | Information to match the data type for the column [define]. | ||||
| flags | A hexadecimal representation of control flags for the column. See text below. | ||||
| Returned Data | |||||
| source_id | If the first row is used as the header, this field will contain the source name. | ||||
| source_index | The zero based source mapped column index. -1 indicates not valid or matched. | ||||
The returned data can be set in the initial map which will force the mapped in the dialog. [The user can change the mapping.]
[To use the function, a string table is defined and the above input columns are defined. The user can select matching columns by view the source data.
[insert picture]
[Auto match is performed by first testing the source_id
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2026 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.