AdminFiles.ReadFromFile

Ee796324.c++_on(en-US,CS.10).gifEe796324.vb_off(en-US,CS.10).gif

Use this method to return the contents of the specified text file. The contents of the file are returned as a text string.

Definition

Function ReadFromFile(bstrFileName As String) As String

Parameters

bstrFileName

A String that specifies the path and file name to read.

Return Values

If this method completes successfully, it returns a String containing the file contents.

Error Values

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Example

' oFile is a reference to a Commerce AdminFiles object.
' sFileContents is a varaible of type String.
sFileContents = oFile.ReadFromFile("c:\temp\newfile.asp")

See Also

AdminFiles Object

IAdminFiles::ReadFromBinaryFile


All rights reserved.