Share via

VSG_DEFAULT_RUN_FILENAME

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Defines the default file name of the graphics log file.

Syntax

#define VSG_DEFAULT_FILENAME filename

Parameters

filename The file name given by default to the graphics log file when graphics information is captured programmatically.

Value

A string literal that represents the file name of the graphics log file. By default, L"default.vsglog".

#define VSG_DEFAULT_FILENAME L"default.vsglog"

Remarks

If the preprocessor symbol DONT_SAVE_VSGLOG_TO_TEMP is defined, then the file name is relative to the current directory of the captured app, or is an absolute path; otherwise, it's relative to the user's temporary files directory and can't be an absolute path.

To change the defined file name, you must redefine it before you include vsgcapture.h in your program.

Example

This example shows how to change the capture file's default file name:

// Redefine the default capture filename before including vsgcapture.h
#define VSG_DEFAULT_FILENAME L"capture.vsglog"

#include <vsgcapture.h>

See also