Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FifteenWindows/OS Functions (continued)

SendMessage Function

Overview

The SendMessage function sends a raw message to the specified target window. This is an advanced function and requires knowledge of Windows messaging.

Syntax/Parameters

Syntax

dword = SendMessage ( handle hwTarget, dword message, dword wParam, dword lParam );

Parameters

hwTarget

An handle that identifies the the target window.

message

A dword windows message.

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.

If the function does not cause an exception, the last error code buffer is always loaded with the Windows API last error.

Remarks

This is an advanced feature that essentially allows a message to be sent to any window. 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 window, a value of zero will be returned without any indication of an error.

The message value is not accepted by the 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