Win_GetMessage

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > Windows API >

Win_GetMessage

 

Description

 

Retrieves a message from the calling thread's message queue.

The function dispatches incoming sent messages until a posted message is available for retrieval.

 

Syntax

 

n = Win_GetMessage(tagMSG, hWnd, wMsgFilterMin, wMsgFilterMax)

 

Returns

 

Number.

If the function retrieves a message other than %WM_QUIT, the return value is nonzero.

If the function retrieves the %WM_QUIT message, the return value is zero.

If there is an error, the return value is -1

 

Parameters

 

Name

Type

Optional

Meaning

tagMSG

Variable

No

A pointer to an TAGMSG structure that receives message information from the thread's message queue

hWnd

Number

No

A handle to the window whose messages are to be retrieved. The window must belong to the current thread.

wMsgFilterMin

Number

No

The integer value of the lowest message value to be retrieved

wMsgFilterMax

Number

No

The integer value of the highest message value to be retrieved

 

Remarks

 

For additional info, please refer to MS documentation at: http://msdn.microsoft.com/en-us/library/ms644936(v=vs.85).aspx

 

Restrictions

 

See also

 

Examples