Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

ControlSendMessage Function

Overview

The ControlSendMessage function sends a raw message to the specified dialog control. This is an advanced function and requires knowledge of Windows messaging.

Syntax/Parameters

Syntax

dword = ControlSendMessage ( int id, dword message, dword wParam, dword lParam );

Parameters

id

An int that identifies the dialog control to send the message.

message

A dword specifying a windows message or a message specific to the control.

wParam

A dword as a 32-bit value specific to the message.

lParam

A dword as a 32-bit value specific to the message.

Return Value

A dword with the message result. On failure of the function, a formatted error code will be returned. Since the return value and error may be ambiguous, the IsError, IsNotError and GetLastError functions can be used to determine if the underlying window message call failed.

The return value is dependent on the message being sent. This is also known as a 32-bit LRESULT (see MSDN). Note that Windows will respond with 0 for a message that does not reach its destination which does not result in a returned error. See Remarks below for additional error and exception information.

Remarks

This is an advanced feature that essentially allows a message to be sent to any control. This message can result in program exceptions. To the extent possible, such exceptions will be captured, If an exception is captured, the value ERROR_MEMORY with a sub code of 0x0010 will be returned and set in the last error code. Use the GetLastError function to retrieve an error code separate from the return result.

If a message is sent to a non-existent control or window, a value of zero will be returned without any indication of an error.

Related Functions 

Platform Support

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

Legato IDE, Legato Basic