VsCodeWindowClass.GetEditorCaption(READONLYSTATUS, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

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

public:
 virtual int GetEditorCaption(Microsoft::VisualStudio::TextManager::Interop::READONLYSTATUS dwReadOnly, [Runtime::InteropServices::Out] System::String ^ % pbstrEditorCaption) = Microsoft::VisualStudio::TextManager::Interop::IVsCodeWindow::GetEditorCaption;

public:
 virtual int GetEditorCaption(Microsoft::VisualStudio::TextManager::Interop::READONLYSTATUS dwReadOnly, [Runtime::InteropServices::Out] System::String ^ % pbstrEditorCaption);

 virtual int GetEditorCaption(Microsoft::VisualStudio::TextManager::Interop::READONLYSTATUS dwReadOnly, [Runtime::InteropServices::Out] std::wstring const & & pbstrEditorCaption);

public virtual int GetEditorCaption (Microsoft.VisualStudio.TextManager.Interop.READONLYSTATUS dwReadOnly, out string pbstrEditorCaption);

abstract member GetEditorCaption : Microsoft.VisualStudio.TextManager.Interop.READONLYSTATUS * string -> int
override this.GetEditorCaption : Microsoft.VisualStudio.TextManager.Interop.READONLYSTATUS * string -> int

Public Overridable Function GetEditorCaption (dwReadOnly As READONLYSTATUS, ByRef pbstrEditorCaption As String) As Integer

Parameters

dwReadOnly: READONLYSTATUS

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

pbstrEditorCaption: String

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

Returns

Int32

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

Implements

GetEditorCaption(READONLYSTATUS, String)

Applies to