• Article

ScriptEditorControl.. Method

Gets the editor caption.

Namespace:  Microsoft.SqlServer.Management.UI.VSIntegration.Editors
Assembly:  SQLEditors.VS (in SQLEditors.VS.dll)

Syntax

'Declaration
Private Function GetEditorCaption ( _
    status As READONLYSTATUS, _
    <OutAttribute> ByRef baseEditorCaption As String _
) As Integer Implements IVsCodeWindow.GetEditorCaption
'Usage
Dim instance As ScriptEditorControl
Dim status As READONLYSTATUS
Dim baseEditorCaption As String
Dim returnValue As Integer

returnValue = CType(instance, IVsCodeWindow).GetEditorCaption(status, _
    baseEditorCaption)

int IVsCodeWindow.GetEditorCaption(
    READONLYSTATUS status,
    out string baseEditorCaption
)

private:
virtual int GetEditorCaption(
    READONLYSTATUS status, 
    [OutAttribute] String^% baseEditorCaption
) sealed = IVsCodeWindow::GetEditorCaption

private abstract GetEditorCaption : 
        status:READONLYSTATUS * 
        baseEditorCaption:string byref -> int 
private override GetEditorCaption : 
        status:READONLYSTATUS * 
        baseEditorCaption:string byref -> int 

JScript supports the use of explicit interface implementations, but not the declarations of new ones.

Parameters

  • status
    Type: READONLYSTATUS
    A READONLYSTATUS object.
  • baseEditorCaption
    Type: System.String%
    A pointer to a string that contains the caption.

Return Value

Type: System.Int32
An integer value that indicates the result of the operation.

Implements

IVsCodeWindowGetEditorCaption(READONLYSTATUS, String%)