  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetSetRowDataWord Function
Overview
The DataSheetSetRowDataWord function sets the 32-bit caller data dword associated with the row.
Syntax/Parameters
Syntax
int = DataSheetSetRowDataWord ( handle hSheet, int index, dword data );
Parameters
hSheet
A handle to a Data Sheet object.
index
A zero-based int representing the row index.
data
A 32-bit dword containing the data to set for the row.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure.
Remarks
The caller row data is a 32-bit value associated with each row and is used by many functions and views to control or group content on templates. The Data Sheet object must have a row array to be able to use this function (although if it does not, the return value will be 0 which is effectively like referencing an uninitialized row data word).
The row array is automatically created if as required.
The caller data can also be retrieved using the DataSheetGetRowProps function. The caller row data is the same as the keyword “CallerData” for row properties.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-04-22
| Table of Contents | < < Previous | Next >> |
© 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.