IVsProjectTextImageProvider::OpenItemTextImage Method (String^, UInt32, VsTextImage^)

 

Opens a text image for a given file.

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

int OpenItemTextImage(
	String^ pszMkDocument,
	unsigned int grfMode,
	[OutAttribute] VsTextImage^% ppTextImage
)

Parameters

pszMkDocument
Type: System::String^

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

grfMode
Type: System::UInt32

[in] Integer. The mode in which to open the image—read only or read/write. A value from the __VSPTIP_MODE enumeration.

ppTextImage
Type: Microsoft.VisualStudio.TextManager.Interop::VsTextImage^

[out] Pointer to the created IVsTextImage interface.

Return Value

Type: System::Int32

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

From vsshell.idl:

[C++]

HRESULT IVsProjectTextImageProvider::OpenItemTextImage(
   [in] LPCOLESTR pszMkDocument, 
   [in] VSPTIP_MODE grfMode
);
Return to top
Show: