VsCodeWindowClass::GetEditorCaption Method (READONLYSTATUS, String^)

Visual Studio 2015
 

Returns the editor caption to which editors can append custom text.

Namespace:   Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

C#
C++
F#
VB
Copy 
public:
virtual int GetEditorCaption(
	READONLYSTATUS dwReadOnly,
	[OutAttribute] String^% pbstrEditorCaption
)

Parameters

dwReadOnly
Type: Microsoft.VisualStudio.TextManager.Interop::READONLYSTATUS

[in] Gets the read and write status of the text buffer. For a list of dwReadOnly values, see READONLYSTATUS 

pbstrEditorCaption
Type: System::String^

[out] Pointer to a BSTR that contains the caption text.

Return Value

Type: System::Int32

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

Implements

IVsCodeWindow::GetEditorCaption(READONLYSTATUS, String^)
Return to top
Show: