CSGetUseCallbacks Function

Description

This function is used to query the callback mechanism that Consoul will use 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 CSGetUseCallbacks Lib "consoul_010205_32.dll" ( _
  ByVal hWnd As Long _
) As Integer

VB/A 64bits

Private Declare PtrSafe Function CSGetUseCallbacks Lib "consoul_010205_64.dll" ( _
  ByVal hWnd As LongPtr _
) As Integer

Return Value

The return value is 0 (zero) if the callback mechanism is messages, or 1 (one) - the default mechanism - if Consoul uses callbacks to the host via callback functions.

Parameters

hWnd

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

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 hosts should use the default callback function mechanism.