Condividi tramite


IVsCodeWindow.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

'Dichiarazione
Function GetEditorCaption ( _
    dwReadOnly As READONLYSTATUS, _
    <OutAttribute> ByRef pbstrEditorCaption As String _
) As Integer
int GetEditorCaption(
    READONLYSTATUS dwReadOnly,
    out string pbstrEditorCaption
)
int GetEditorCaption(
    [InAttribute] READONLYSTATUS dwReadOnly, 
    [OutAttribute] String^% pbstrEditorCaption
)
abstract GetEditorCaption : 
        dwReadOnly:READONLYSTATUS * 
        pbstrEditorCaption:string byref -> int 
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.

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
);

.NET Framework Security

See Also

Reference

IVsCodeWindow Interface

Microsoft.VisualStudio.TextManager.Interop Namespace