XErrorSetCallback

ゲーム OS またはゲーム ランタイムでエラーが発生した場合に呼び出されるコールバックを指定します。

構文

void XErrorSetCallback(  
         XErrorCallback* callback,  
         void* context  
)  

パラメーター

callback _In_
型: XErrorCallback*

呼び出すゲーム定義のコールバックへのポインター。 nullptr で渡すと、コールバックがクリアされます。

context _In_
型: void*

コールバックのコンテキスト ポインター。

戻り値

型: void

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」をご覧ください。

この関数を使用し、システムがエラーが発生した場合に呼び出す XErrorSetCallback コールバックを指定し、XErrorSetOptions関数を使用して、ゲーム OS またはゲーム ランタイムでエラーが発生したときのゲームの動作を指定します。

次の例は、エラー オプションを設定する方法、カスタム エラー コールバックを定義する方法、システムからエラー通知を受け取るためにカスタム エラー コールバックを設定する方法を説明しています。

bool CustomGameXErrorCallback(_In_ HRESULT hr, _In_ const char* msg, _In_ void* context)  
{  
   // Capture the error to the game's custom logger  
   CustomGameLogger* logger = (CustomGameLogger*)context;  
   logger->ReportGameRuntimeIssue(hr, msg);  
  
   // Don't ignore the error. For example, continue on and do whatever  
   // is specified by XErrorSetOptions().  
   return true;  
}  
  
void SomeGameFunction()  
{  
   // Previously initialize the game's custom logger  
   // CustomGameLogger* m_logger = InitializeLogger();  
   // ...  
  
   // Setup how you want to handle XErrors  
   XErrorSetOptions(DebugBreakOnError, FailFastOnError);
   XErrorSetCallback(CustomGameXErrorCallback, m_logger);
}  

要件

ヘッダー: XError.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XError メンバー
XErrorCallback