CSSetUseCallbacks Function

Description

This function changes the callback mechanism that Consoul uses to notify its host of events occuring in the console window. See Messages and callbacks for an explanation of the mechanism and supported events.

Syntax

VB/A 32bits

Private Declare Function CSSetUseCallbacks Lib "consoul_010205_32.dll" ( _
  ByVal hWnd As Long, _
  Byval wUseCallbacks As Integer _
) As Integer

VB/A 64bits

Private Declare PtrSafe Function CSSetUseCallbacks Lib "consoul_010205_32.dll" ( _
  ByVal hWnd As LongPtr, _
  Byval wUseCallbacks As Integer _
) As Integer

Return Value

The return value is the previous notification mechanism that was in place, which 0 (zero) if the callback mechanism was messages, or 1 (one) if the callback mechanism was callback functions.

Parameters

hWnd

The window handle (HWND) of the Consoul window, as returned by CSCreateLogWindow.

wUseCallbacks

0 (zero) to let Consoul use Win32 messages to notifiy its host, or 1 (one) for callback functions which is the default.

Remarks

Working with the messages callback mechanism requires a host that can actually process Win32 API messages sent to the parent window of the Consoul window. VBA Hosts do not have this possibility without implementing a form of subclassing, which is not recommended. Such host should use the default callback function mechanism.

Last updated: May 13 2022.