Sets the last-error code for the calling thread.

Syntax

void WINAPI SetLastError(
  __in  DWORD dwErrCode
);

Parameters

dwErrCode [in]

The last-error code for the thread.

Return Value

This function does not return a value.

Remarks

The last-error code is kept in thread local storage so that multiple threads do not overwrite each other's values.

Most functions call SetLastError or SetLastErrorEx only when they fail. However, some system functions call SetLastError or SetLastErrorEx under conditions of success; those cases are noted in each function's documentation.

Applications can optionally retrieve the value set by this function by using the GetLastError function immediately after a function fails.

Error codes are 32-bit values (bit 31 is the most significant bit). Bit 29 is reserved for application-defined error codes; no system error code has this bit set. If you are defining an error code for your application, set this bit to indicate that the error code has been defined by your application and to ensure that your error code does not conflict with any system-defined error codes.

Requirements

See Also

Error Handling Functions
GetLastError
Last-Error Code
SetLastErrorEx

Send comments about this topic to Microsoft

Build date: 11/20/2008