IVsTextImageUtilities.LoadTextImageFromFile Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Loads a text image from the specified file.

public:
 int LoadTextImageFromFile(System::String ^ pszFileName, Microsoft::VisualStudio::TextManager::Interop::IVsTextImage ^ pImage, System::UInt32 vstffIn, [Runtime::InteropServices::Out] System::UInt32 % pvstffOut);

int LoadTextImageFromFile(std::wstring const & pszFileName, Microsoft::VisualStudio::TextManager::Interop::IVsTextImage const & pImage, unsigned int vstffIn, [Runtime::InteropServices::Out] unsigned int & pvstffOut);

public int LoadTextImageFromFile (string pszFileName, Microsoft.VisualStudio.TextManager.Interop.IVsTextImage pImage, uint vstffIn, out uint pvstffOut);

abstract member LoadTextImageFromFile : string * Microsoft.VisualStudio.TextManager.Interop.IVsTextImage * uint32 * uint32 -> int

Public Function LoadTextImageFromFile (pszFileName As String, pImage As IVsTextImage, vstffIn As UInteger, ByRef pvstffOut As UInteger) As Integer

Parameters

pszFileName

String

[in] The name of the file.

pImage

IVsTextImage

[in] The text image to load.

vstffIn

UInt32

[in] Instructions for text format and detection.

pvstffOut

UInt32

[out] The text format used.

Returns

Int32

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

Remarks

COM Signature

From textfind.idl:

HRESULT IVsTextImageUtilities::LoadTextImageFromFile(  
   [in] LPCOLESTR pszFilename,  
   [in] IVsTextImage * pImage,  
   [in] VSTFF vstffIn  
   [out, retval] VSTFF * pvstffOut  
);