GetHoveringUiElement

ISettlers4Api::GetHoveringUiElement method

Get the UI element of The Settlers 4 that the mouse cursor is currently hovering over.

Syntax

HRESULT ISettlers4Api::GetHoveringUiElement(
	LPS4UIELEMENT lpOut
);

Parameters

lpOut

A pointer to a S4UiElement structure that is to receive the data.

Return value

Returns 0 (zero) on success. Non-zero on failure.

Remarks

none

Requirements

Minimum API Level	1
Target Edition	Any
Header	S4ModApi.h
Library	S4ModApi.lib
DLL	S4ModApi.dll

See also

ISettlers4Api