IVsCodeWindow.SetBaseEditorCaption(String[]) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Appends custom text to the editor caption

public:
 int SetBaseEditorCaption(cli::array <System::String ^> ^ pszBaseEditorCaption);

public:
 int SetBaseEditorCaption(Platform::Array <Platform::String ^> ^ pszBaseEditorCaption);

int SetBaseEditorCaption(std::Array <std::wstring const &> const & pszBaseEditorCaption);

public int SetBaseEditorCaption (string[] pszBaseEditorCaption);

abstract member SetBaseEditorCaption : string[] -> int

Public Function SetBaseEditorCaption (pszBaseEditorCaption As String()) As Integer

Parameters

pszBaseEditorCaption

String[]

[in] Pointer to the base editor caption string.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsCodeWindow::SetBaseEditorCaption(  
   [in] LPCOLESTR *pszBaseEditorCaption  
);