IVsProjectTextImageProvider.CloseItemTextImage Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Closes the text image of a project item.

public:
 int CloseItemTextImage(System::String ^ pszMkDocument, System::UInt32 vsptipDisposition, Microsoft::VisualStudio::TextManager::Interop::VsTextImage ^ pTextImage);

public:
 int CloseItemTextImage(Platform::String ^ pszMkDocument, unsigned int vsptipDisposition, Microsoft::VisualStudio::TextManager::Interop::VsTextImage ^ pTextImage);

int CloseItemTextImage(std::wstring const & pszMkDocument, unsigned int vsptipDisposition, Microsoft::VisualStudio::TextManager::Interop::VsTextImage const & pTextImage);

public int CloseItemTextImage (string pszMkDocument, uint vsptipDisposition, Microsoft.VisualStudio.TextManager.Interop.VsTextImage pTextImage);

abstract member CloseItemTextImage : string * uint32 * Microsoft.VisualStudio.TextManager.Interop.VsTextImage -> int

Public Function CloseItemTextImage (pszMkDocument As String, vsptipDisposition As UInteger, pTextImage As VsTextImage) As Integer

Parameters

pszMkDocument

String

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

vsptipDisposition

UInt32

[in] Integer. A value from the __VSPTIP_DISPOSITION enumeration indicating whether or not the file was modified or whether to just close it.

pTextImage

VsTextImage

[in] Pointer to the IVsTextImage interface of the text image.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

[C++]

HRESULT IVsProjectTextImageProvider::CloseItemTextImage(  
   [in] LPCOLESTR pszMkDocument,   
   [in] VSPTIP_DISPOSITION vsptipDisposition  
);