Share via

XErrorOptions

  • Article

Describes how the game should behave when an error occurs in the gaming OS or gaming runtime.

Syntax

enum class XErrorOptions  : uint32_t  
{  
    None = 0x00,  
    OutputDebugStringOnError = 0x01,  
    DebugBreakOnError = 0x02,  
    FailFastOnError = 0x04,  
}

Constants

Constant Description
None On error, do nothing.
This is the default option if a debugger is not present.
OutputDebugStringOnError On error, output debug messages.
This is the default option if a debugger is present.
DebugBreakOnError On error, break into the debugger and output debug messages.
FailFastOnError On error, request a fast fail to immediately terminate the calling process.

Remarks

XErrorOptions is used by the XErrorSetOptions function to describe how the game should behave when an error occurs, depending on whether a debugger is present. If OutputDebugStringOnError or DebugBreakOnError is specified and a debugger is present, a debug string containing the HRESULT error code, current thread ID, and error message is sent to the debugger for display. If DebugBreakOnError is specified, the game breaks into the debugger.

Requirements

Header: XError.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XError members
XErrorSetOptions