Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FifteenWindows/OS Functions (continued)

GetParentWindow Function

Overview

The GetParentWindow function returns the parent (owner) window handle for a provided window handle.

Syntax/Parameters

Syntax

handle = GetParentWindow ( handle hWindow );

Parameters

hWindow

A handle representing a window.

Return Value

Returns a handle of the parent window or NULL_HANDLE on error. Use the GetLastError function to retrieve a formatted error code. On error, the underlying error number will be a Windows API error code.

This function typically fails for one of the following reasons:

–  The provided hWindow parameter is invalid.

–  The window is a top-level window that is unowned or does not have the WS_POPUP style.

–  The owner window has WS_POPUP style.

Remarks

If the window is a child window, the return value is a handle to the parent window. If the window is a top-level window with the WS_POPUP style, the return value is a handle to the owner window.

Related Functions

Platform Support

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

Legato IDE, Legato Basic