XtfCaptureOutputBegin

Article
06/22/2023

Starts capture of debug output.

Syntax

void XtfCaptureOutputBegin(
         PCWSTR address,
         XtfDebugStringCallback debugStringCallback,
         XtfDebugStringErrorCallback debugStringErrorCallback,
         PVOID context,
         PHANDLE hListen
)

Parameters

address
Type: PCWSTR

[in] The IP address of the console.

debugStringCallback
Type: XtfDebugStringCallback

[in, optional] An optional callback invoked for each output debug string.

debugStringErrorCallback
Type: XtfDebugStringErrorCallback

[in, optional] An optional callback invoked for each error encountered.

context
Type: PVOID

[in, optional] A pointer to an object that is passed into the callback functions. This object allows each callback invocation to be associated with this capture session.

hListen
Type: PHANDLE

[out] The handle that represents this capture session.

Return value

None.

Remarks

Use this function and the XtfCaptureOutputEnd function to start and stop capturing general debug output from a development console. If you want to monitor debug output from a specific process ID on a development console, use a debug monitor client. For more information about using a debug monitor client, see XtfCreateDebugMonitorClient.

You must implement and specify a XtfDebugStringCallback function in debugStringCallback if you want to capture debug strings for a capture session. Similarly, you must implement and specify an XtfDebugStringErrorCallback function in debugStringErrorCallback to capture errors encountered during a capture session. Neither callback function is required, however.

To stop capturing debug output and free the resources associated with a capture session, call XtfCaptureOutputEnd and specify the handle returned in hListen for that capture session.

Note

You must call XtfCaptureOutputEnd to stop a capture session. Otherwise, the capture session is orphaned and the resources associated with the capture session are not freed, causing a memory leak.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via