IVsRegisterEditors.RegisterEditor Method

Registers an editor.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function RegisterEditor ( _
    ByRef rguidEditor As Guid, _
    pVsPF As IVsEditorFactory, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer
int RegisterEditor(
    ref Guid rguidEditor,
    IVsEditorFactory pVsPF,
    out uint pdwCookie
)
int RegisterEditor(
    [InAttribute] Guid% rguidEditor, 
    [InAttribute] IVsEditorFactory^ pVsPF, 
    [OutAttribute] unsigned int% pdwCookie
)
abstract RegisterEditor : 
        rguidEditor:Guid byref * 
        pVsPF:IVsEditorFactory * 
        pdwCookie:uint32 byref -> int
function RegisterEditor(
    rguidEditor : Guid, 
    pVsPF : IVsEditorFactory, 
    pdwCookie : uint
) : int

Parameters

  • rguidEditor
    Type: Guid%

    [in] Unique GUID of the editor that was registered.

  • pdwCookie
    Type: UInt32%

    [out] Abstract handle to be used later to unregister this editor.

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRegisterEditors::RegisterEditor(
   [in] REFGUID rguidEditor,
   [in] IVsEditorFactory *pVsPF,
   [out] VSCOOKIE *pdwCookie
);

The GUID of the editor factory that was registered is used in the VSPackages SetSite.

.NET Framework Security

See Also

Reference

IVsRegisterEditors Interface

Microsoft.VisualStudio.Shell.Interop Namespace