  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetGetRowDataWord Function
Overview
The DataSheetGetRowDataWord function returns the 32-bit caller dword associated with the row.
Syntax/Parameters
Syntax
dword = DataSheetGetRowDataWord ( handle hSheet, int index );
Parameters
hSheet
A handle to a Data Sheet object.
index
A zero-based int representing the row index.
Return Value
Returns a dword representing the caller row data or 0 on failure. Use the IsError and IsNotError functions to detect an error and the GetLastError function to retrieve error information. Since the row dword can be set to 0 (the default), the last error must be examined to determine if an error occurred.
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. This meta data is not used by the data sheet and is carried specifically to support functions using the Data Sheet Object.
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 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-12-13
| 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.