IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) Method

Definition

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

public int GetEditorCaption (Microsoft.VisualStudio.TextManager.Interop.READONLYSTATUS dwReadOnly, out string pbstrEditorCaption);
abstract member GetEditorCaption : Microsoft.VisualStudio.TextManager.Interop.READONLYSTATUS *  -> int
Public Function GetEditorCaption (dwReadOnly As READONLYSTATUS, ByRef pbstrEditorCaption As String) As Integer
Parameters
dwReadOnly
READONLYSTATUS READONLYSTATUS READONLYSTATUS

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

pbstrEditorCaption
String String String

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

Returns

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

Remarks

This method determines the read-only status by checking with the associated text buffer.

COM Signature

From textmgr.idl:

HRESULT IVsCodeWindow::GetEditorCaption(  
   [in] READONLYSTATUS dwReadOnly,  
   [out] BSTR *pbstrEditorCaption  
);  

Applies to