Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

DataSheetGetObject Function

Overview

The DataSheetGetObject function retrieves the Data Sheet Object from an edit window.

Syntax/Parameters

Syntax

handle = DataSheetGetObject ( handle hWindow );

Parameters

hWindow

A handle to an edit window. Note that each view will have a separate Data Sheet object. If the handle points to the client window (the window containing all the views), the last active view’s data sheet will be returned. Use the Edit Manager and functions such as GetEditWindowHandle to retrieve view handles.

Return Value

Returns a handle representing a Data Sheet object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

The handle to the Data Sheet object belongs to the associated view and when closed only releases the link to the data. If any changes have been made to the sheet, the close action will issue a window update. Programmers should be very careful about modifying the content of various views since the view manager may need to be updated for certain application-level functionality to operate correctly.

The Data Sheet Object should be closed using the CloseHandle function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic