GetLastError

ISettlers4Api::GetLastError method

Retrieves the calling thread's last-error code value of the ISettlers4API methods. The last-error code is maintained on a per-thread basis. Multiple threads do not overwrite each other's last-error code.

Syntax

DWORD ISettlers4Api::GetLastError();

Parameters

none

Return value

The return value is the calling thread's last-error code.

The return value section of the documentation for each function that sets the last-error code notes the conditions under which the function sets the last-error code. Most functions that set the thread's last-error code set it when they fail. However, some functions also set the last-error code when they succeed. If the function is not documented to set the last-error code, the value returned by this function is simply the most recent last-error code to have been set; some functions set the last-error code to 0 on success and others do not.

Remarks

This method is currently not implemented and will always return 0.

Requirements

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

See also

ISettlers4Api