Share via


VsCodeWindowClass.GetEditorCaption Method

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)

Syntax

'Declaration
Public Overridable Function GetEditorCaption ( _
    dwReadOnly As READONLYSTATUS, _
    <OutAttribute> ByRef pbstrEditorCaption As String _
) As Integer
public virtual int GetEditorCaption(
    READONLYSTATUS dwReadOnly,
    out string pbstrEditorCaption
)
public:
virtual int GetEditorCaption(
    [InAttribute] READONLYSTATUS dwReadOnly, 
    [OutAttribute] String^% pbstrEditorCaption
)
abstract GetEditorCaption : 
        dwReadOnly:READONLYSTATUS * 
        pbstrEditorCaption:string byref -> int  
override GetEditorCaption : 
        dwReadOnly:READONLYSTATUS * 
        pbstrEditorCaption:string byref -> int
public function GetEditorCaption(
    dwReadOnly : READONLYSTATUS, 
    pbstrEditorCaption : String
) : int

Parameters

  • 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%)

.NET Framework Security

See Also

Reference

VsCodeWindowClass Class

Microsoft.VisualStudio.TextManager.Interop Namespace