IVsCodeWindow.GetEditorCaption Method

Article
05/06/2010

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

'Déclaration
Function GetEditorCaption ( _
    dwReadOnly As READONLYSTATUS, _
    <OutAttribute> ByRef pbstrEditorCaption As String _
) As Integer
'Utilisation
Dim instance As IVsCodeWindow
Dim dwReadOnly As READONLYSTATUS
Dim pbstrEditorCaption As String
Dim returnValue As Integer

returnValue = instance.GetEditorCaption(dwReadOnly, _
    pbstrEditorCaption)

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

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

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.

Partager via