Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

DataControlGetString Function

Overview

The DataControlGetString function retrieves a formatted string for a specified row.

Syntax/Parameters

Syntax

string = DataControlGetString ( int id, int row, [dword type] );

Parameters

id

An int containing the control ID of the data control.

row

An int specifying the zero-based index to a row.

type

An optional dword specifying the format for the returned data: DCC_GS_TABBED, DCC_GS_SPACES or DCC_GS_COMMA. The default is DCC_GS_TABBED.

Return Value

A string containing the data for the row. The maximum size if 2MB. On failure, an empty string is returned. Not that a single column sheet in space or tab mode can return an empty string if the row is empty. Use the GetLastError function to retrieve error information.

Remarks

The DataControlGetString function allows a single row to be retrieved.

Related Functions

Platform Support

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

Legato IDE, Legato Basic