IVsTextImageUtilities::SaveTextImageToFile Method (String^, IVsTextImage^, UInt32, UInt32)

Visual Studio 2015

Saves a text image to a file.

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

Syntax

C++

int SaveTextImageToFile(
	String^ pszFileName,
	IVsTextImage^ pImage,
	unsigned int vstffIn,
	[OutAttribute] unsigned int% pvstffOut
)

Parameters

pszFileName: Type: System::String^
[in] The name of the file.

pImage: Type: Microsoft.VisualStudio.TextManager.Interop::IVsTextImage^
[in] The text image.

vstffIn: Type: System::UInt32
[in] Instructions for text format and detection.

pvstffOut: Type: System::UInt32
[out] The format used.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From textfind.idl:

C++

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