IVsSimpleDocFactory.LoadDocument(String, Guid, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Loads the given file into a document data object and returns the given interface on that object.

public:
 int LoadDocument(System::String ^ pszMkDocument, Guid % riid, [Runtime::InteropServices::Out] IntPtr % ppDocData);

public int LoadDocument (string pszMkDocument, ref Guid riid, out IntPtr ppDocData);

abstract member LoadDocument : string * Guid * nativeint -> int

Public Function LoadDocument (pszMkDocument As String, ByRef riid As Guid, ByRef ppDocData As IntPtr) As Integer

Parameters

pszMkDocument: String

[in] Pointer to a string containing the path and file name.

riid: Guid

[in] Pointer to a GUID that is the REFIID of the interface desired.

ppDocData: IntPtr
nativeint

[out] Pointer to the desired interface on the object implementing IVsPersistDocData.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsSimpleDocFactory::LoadDocument(  
   [in] LPCOLESTR pszMkDocument,   
   [in] REFIID riid,   
   [out, iid_is(riid)] void **ppDocData  
);

Applies to

Share via