IVsTextImageUtilities.LoadTextImageFromFile Method

Loads a text image from the specified file.

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

Syntax

'Declaration
Function LoadTextImageFromFile ( _
    pszFileName As String, _
    pImage As IVsTextImage, _
    vstffIn As UInteger, _
    <OutAttribute> ByRef pvstffOut As UInteger _
) As Integer

int LoadTextImageFromFile(
    string pszFileName,
    IVsTextImage pImage,
    uint vstffIn,
    out uint pvstffOut
)

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

abstract LoadTextImageFromFile : 
        pszFileName:string * 
        pImage:IVsTextImage * 
        vstffIn:uint32 * 
        pvstffOut:uint32 byref -> int

function LoadTextImageFromFile(
    pszFileName : String, 
    pImage : IVsTextImage, 
    vstffIn : uint, 
    pvstffOut : uint
) : int

Parameters

pszFileName
Type: System.String

[in] The name of the file.

pImage
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextImage

[in] The text image to load.

vstffIn
Type: System.UInt32

[in] Instructions for text format and detection.

pvstffOut
Type: System.UInt32%

[out] The text 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:

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.