GetSelection

ISettlers4Api::GetSelection method

Get the current selection. This will retrieve the indices of the objects in the settlers pool.

BOOL ISettlers4Api::GetSelection(
	PWORD lpOut, 
	SIZE_T szOut, 
	PSIZE_T lpSelectionCount
);

lpOut

A buffer that receives the indices. If this parameter is NULL it is ignored.

szOut

The length of the buffer in elements.

lpSelectionCount

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

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

none