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

• 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

Implements

IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String%)

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VsCodeWindowClass Class

Microsoft.VisualStudio.TextManager.Interop Namespace