IVsCommandWindow.LogToFile(String, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Starts logging command-window commands and output to the specified file.

public:
 int LogToFile(System::String ^ szLogFile, System::UInt32 grfFlags);

public:
 int LogToFile(Platform::String ^ szLogFile, unsigned int grfFlags);

int LogToFile(std::wstring const & szLogFile, unsigned int grfFlags);

public int LogToFile (string szLogFile, uint grfFlags);

abstract member LogToFile : string * uint32 -> int

Public Function LogToFile (szLogFile As String, grfFlags As UInteger) As Integer

Parameters

szLogFile: String

[in] Filename to use for the log.

grfFlags: UInt32

[in] Bit flags indicating logging options. Use values from the LOGTOFILEOPTION enumeration.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsCommandWindow::LogToFile(  
   [in, ref] LPCOLESTR szLogFile,   
   [in] LOGTOFILEOPTIONS grfFlags  
);

Applies to