RemoveSelection

ISettlers4Api::RemoveSelection method

Remove objects from the current selection. If you wish to remove all elements from the selection, consider calling ISettlers4Api::ClearSelection.

Syntax

BOOL ISettlers4Api::RemoveSelection(
	PWORD settlers, 
	SIZE_T settlerslen, 
	PSIZE_T removedCount
);

Parameters

settlers

A buffer that receives the indices. If this parameter is NULL it is ignored the RemoveSelection will return FALSE.

settlerslen

The length of the buffer in elements.

removedCount

If this parameter is NULL it is ignored. Otherwise it will point to a SIZE_T that will receive the amount of elements that have been removed from the current selection.

Return value

If this method could modify the selection successfully it will return TRUE. If an error occurred it will return FALSE.

Remarks

none

Requirements

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

See also

ISettlers4Api

ISettlers4Api::GetSelection

ISettlers4Api::ClearSelection