IVsOutputWindowPane.OutputStringThreadSafe(String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Writes text to the Output window pane.

public:
 int OutputStringThreadSafe(System::String ^ pszOutputString);

public:
 int OutputStringThreadSafe(Platform::String ^ pszOutputString);

int OutputStringThreadSafe(std::wstring const & pszOutputString);

public int OutputStringThreadSafe (string pszOutputString);

abstract member OutputStringThreadSafe : string -> int

Public Function OutputStringThreadSafe (pszOutputString As String) As Integer

Parameters

pszOutputString

String

[in] Text to be appended to the Output window pane.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

From vsshell.idl:

HRESULT IVsOutputWindowPane::OutputStringThreadSafe(  
   [in] LPCOLESTR pszOutputString  
);  

This method is not free-threaded as implemented by the SVsOutputWindow. This method is similar to OutputString but (as implemented by the SVsOutputWindow service) runs a filtered message pump (which only permits RPC messages to be handled) instead of an open message pump (which allows user input).

It is recommended to try to cast the pane to OutputStringNoPump and invoke OutputStringNoPump instead to avoid a message pump, and fallback to using this OutputStringThreadSafe method if the cast fails.