Export (0) Print
Expand All

IVsInvisibleEditorManager.RegisterInvisibleEditor Method

Registers an invisible editor on the specified document.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int RegisterInvisibleEditor (
	[InAttribute] string pszMkDocument,
	[InAttribute] IVsProject pProject,
	[InAttribute] uint dwFlags,
	[InAttribute] IVsSimpleDocFactory pFactory,
	out IVsInvisibleEditor ppEditor
)
int RegisterInvisibleEditor (
	/** @attribute InAttribute() */ String pszMkDocument, 
	/** @attribute InAttribute() */ IVsProject pProject, 
	/** @attribute InAttribute() */ UInt32 dwFlags, 
	/** @attribute InAttribute() */ IVsSimpleDocFactory pFactory, 
	/** @attribute OutAttribute() */ /** @ref */ IVsInvisibleEditor ppEditor
)
JScript does not support passing value-type arguments by reference.

Parameters

pszMkDocument

The name of the document.

pProject

The project to which the file must belong. If a null reference (Nothing in Visual Basic) is supplied, the file can belong to any project; when opened, it is opened by whichever project responds to IsDocumentInAProject from the shell (including the miscellaneous files project).

dwFlags

Zero or more _EDITORREGFLAGS values; If REIF_ENABLECACHING flag is set, the document is loaded and placed in the RDT immediately, if not already present, and attempts are made to keep the document there as long as possible; certain actions may force it to be unlocked, such as user closing without saving, etc. This allows the document to stay in the RDT in the scenario where a document is open in a visible editor, and closed by the user while an invisible editor is registered for that document. Otherwise, the document is not loaded until GetDocData is called (unless. of course, it is already in memory), and no unnecessary attempts to keep the document in the RDT while this editor is registered are made.

pFactory

An instance of IVsSimpleDocFactory that is used to load the document if it isn't already open. If a null reference (Nothing in Visual Basic) is supplied, a default editor factory is used to load the file into a shell-provided instance of IVsTextLines.

ppEditor

Filled with the newly created and registered invisible editor instance.

Return Value

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

COM Signature

From vsshell.idl:

HRESULT IVsInvisibleEditorManager::RegisterInvisibleEditor(
   [in] LPCOLESTR pszMkDocument, 
   [in] IVsProject *pProject, 
   [in] EDITORREGFLAGS dwFlags, 
   [in] IVsSimpleDocFactory *pFactory, 
   [out] IVsInvisibleEditor **ppEditor
);

Community Additions

ADD
Show:
© 2015 Microsoft