IVsTextImageUtilities.LoadTextFile Method

Article
2013-11-25

Loads the specified text file.

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

Syntax

'Declaration
Function LoadTextFile ( _
    pszFileName As String, _
    vstffIn As UInteger, _
    <OutAttribute> ByRef pvstffOut As UInteger, _
    <OutAttribute> ByRef pbstr As String _
) As Integer

int LoadTextFile(
    string pszFileName,
    uint vstffIn,
    out uint pvstffOut,
    out string pbstr
)

int LoadTextFile(
    [InAttribute] String^ pszFileName, 
    [InAttribute] unsigned int vstffIn, 
    [OutAttribute] unsigned int% pvstffOut, 
    [OutAttribute] String^% pbstr
)

abstract LoadTextFile : 
        pszFileName:string * 
        vstffIn:uint32 * 
        pvstffOut:uint32 byref * 
        pbstr:string byref -> int

function LoadTextFile(
    pszFileName : String, 
    vstffIn : uint, 
    pvstffOut : uint, 
    pbstr : String
) : int

Parameters

pszFileName
Type: System.String

[in] Name of file to load.

vstffIn
Type: System.UInt32

[in] Instructions for text format and detection

pvstffOut
Type: System.UInt32%

[out] The format used.

pbstr
Type: System.String%

[out] The text from the file.

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::LoadTextFile(
   [in] LPCOLESTR pszFilename,
   [in] VSTFF vstffIn,
   [out] VSTFF * pvstffOut,
   [out, retval] BSTR * pbstr
);

.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.

Share via