Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

GetMessageParameter Function

Overview

The GetMessageParameter function retrieves one parameter of many associated with the current message or with the support class.

Syntax/Parameters

Syntax

dword = GetMessageParameter ( [int type] )

Parameters

type

An int that specifies the data to retrieve. The default value is GMP_TYPE_LPARAM.

Return Value

A 32-bit dword value representing the specified type. Use the GetLastError function to determine if an error occurred.

Remarks

The type codes are as follows:

  Definition  Code  Description
  Page Class:      
   GMP_TYPE_P_TYPE   0  Type of Page
   GMP_TYPE_P_LEVEL   1  Level of Page (tree type)
   GMP_TYPE_P_NUMBER   2  Page Number
   GMP_TYPE_HWPARENT   3  Page (Dialog/Prop) Window Handle
   GMP_TYPE_FLAGS   4  Control Flags
  Raw Current Message Information:      
   GMP_TYPE_HWPAGE   5  Page (Dialog) Window Handle
   GMP_TYPE_MESSAGE   6  Message ID (WM_)
   GMP_TYPE_WPARAM   7  “Word” Message Parameter
   GMP_TYPE_LPARAM   8  “Long” Message Parameter
  Translated Message:      
   GMP_TYPE_P_AC   9  Page Action Code
   GMP_TYPE_C_ID   10  Control ID
   GMP_TYPE_C_AC   11  Control Action Code (Message)
   GMP_TYPE_C_LP   12  Control lParam (param data)
   GMP_TYPE_C_HDR   13  Control Notification
  Parent:      
   GMP_TYPE_DIALOG   14  Dialog Class Pointer (parent)
  Page Data:      
   GMP_TYPE_PX   15  Page Index (Property Sheet)

 

This function may only be used within a dialog procedure. The data returned is related to the current procedures.

Related Functions

Platform Support

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

Legato IDE, Legato Basic