IsEdition

ISettlers4Api::IsEdition method

Check the currently attached edition of The Settlers 4.

Syntax

BOOL ISettlers4Api::IsEdition(
	S4_EDITION_ENUM edition
);

Parameters

edition

The features of the currently running game version. It can be one of the following values.

Value	Meaning
S4_EDITION_GOLD 0x00000001	The gold edition of The Settlers 4.
S4_EDITION_HISTORY 0x00000002	The history edition of The Settlers 4.

Return value

TRUE if the requested edition has been detected. FALSE otherwise.

Remarks

none

Requirements

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

See also

ISettlers4Api