EditorFactoryBase.IVsEditorFactory.CreateEditorInstance Method

The interop provider.

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

Syntax

'Declaration
Private Function CreateEditorInstance ( _
    createFlags As UInteger, _
    moniker As String, _
    physicalView As String, _
    hierarchy As IVsHierarchy, _
    itemId As UInteger, _
    existingDocData As IntPtr, _
    <OutAttribute> ByRef docViewIntPtr As IntPtr, _
    <OutAttribute> ByRef docDataIntPtr As IntPtr, _
    <OutAttribute> ByRef caption As String, _
    <OutAttribute> ByRef cmdUIGuid As Guid, _
    <OutAttribute> ByRef result As Integer _
) As Integer Implements IVsEditorFactory.CreateEditorInstance
'Usage
Dim instance As EditorFactoryBase 
Dim createFlags As UInteger 
Dim moniker As String 
Dim physicalView As String 
Dim hierarchy As IVsHierarchy 
Dim itemId As UInteger 
Dim existingDocData As IntPtr 
Dim docViewIntPtr As IntPtr 
Dim docDataIntPtr As IntPtr 
Dim caption As String 
Dim cmdUIGuid As Guid 
Dim result As Integer 
Dim returnValue As Integer 

returnValue = CType(instance, IVsEditorFactory).CreateEditorInstance(createFlags, _
    moniker, physicalView, hierarchy, _
    itemId, existingDocData, docViewIntPtr, _
    docDataIntPtr, caption, cmdUIGuid, _
    result)

int IVsEditorFactory.CreateEditorInstance(
    uint createFlags,
    string moniker,
    string physicalView,
    IVsHierarchy hierarchy,
    uint itemId,
    IntPtr existingDocData,
    out IntPtr docViewIntPtr,
    out IntPtr docDataIntPtr,
    out string caption,
    out Guid cmdUIGuid,
    out int result
)

private:
virtual int CreateEditorInstance(
    unsigned int createFlags, 
    String^ moniker, 
    String^ physicalView, 
    IVsHierarchy^ hierarchy, 
    unsigned int itemId, 
    IntPtr existingDocData, 
    [OutAttribute] IntPtr% docViewIntPtr, 
    [OutAttribute] IntPtr% docDataIntPtr, 
    [OutAttribute] String^% caption, 
    [OutAttribute] Guid% cmdUIGuid, 
    [OutAttribute] int% result
) sealed = IVsEditorFactory::CreateEditorInstance

private abstract CreateEditorInstance : 
        createFlags:uint32 * 
        moniker:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docViewIntPtr:IntPtr byref * 
        docDataIntPtr:IntPtr byref * 
        caption:string byref * 
        cmdUIGuid:Guid byref * 
        result:int byref -> int  
private override CreateEditorInstance : 
        createFlags:uint32 * 
        moniker:string * 
        physicalView:string * 
        hierarchy:IVsHierarchy * 
        itemId:uint32 * 
        existingDocData:IntPtr * 
        docViewIntPtr:IntPtr byref * 
        docDataIntPtr:IntPtr byref * 
        caption:string byref * 
        cmdUIGuid:Guid byref * 
        result:int byref -> int

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

Parameters

• createFlags
  Type: System.UInt32
  Integer flag value.

• moniker
  Type: System.String
  A string value that specifies the moniker.

• physicalView
  Type: System.String
  A string value that specifies the view.

• hierarchy
  Type: IVsHierarchy
  A IVsHierarchy object.

• itemId
  Type: System.UInt32
  Integer value of the item ID.

• existingDocData
  Type: System.IntPtr
  A IntPtr.

• docViewIntPtr
  Type: System.IntPtr%
  A pointer to a IntPtr.

• docDataIntPtr
  Type: System.IntPtr%
  A pointer to a IntPtr.

• caption
  Type: System.String%
  A pointer to a string value that contains the caption.

• cmdUIGuid
  Type: System.Guid%
  A pointer to Guid of UI.

• result
  Type: System.Int32%
  Pointer to an integer that indicates the result.

Return Value

Type: System.Int32
A defined integer value, such as S_OK.

Implements

IVsEditorFactoryCreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32)

See Also

Reference

EditorFactoryBase Class

Microsoft.SqlServer.Management.UI.VSIntegration.Editors Namespace