IAdminFiles::ReadFromFile Method [C++]

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

Definition

[C++]

HRESULT IAdminFiles::ReadFromFile(BSTRbstrFileName,
 BSTR*pbstrOut);

[Visual Basic]

Function ReadFromFile(bstrFileName As String) As String

Parameters

  • bstrFileName[C++]
    [in] A BSTR that specifies the path and file name to read.
  • bstrFileName[Visual Basic]
    A String that specifies the path and file name to read.
  • pbstrOut [C++]
    [out] The address of a BSTR used to return the file contents.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a String containing the file contents.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT 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, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] 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

[C++] The pbstrOut parameter contains valid data only if the method returns successfully.

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

[Visual Basic]

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

[C++]AdminFiles Object

[C++]IAdminFiles::ReadFromBinaryFile

[Visual Basic]AdminFiles Object

[Visual Basic]IAdminFiles::ReadFromBinaryFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.