IFaxDoc::put_FileName

The IFaxPort::put_FileName method changes the FileName property for a FaxDoc object. The FileName property is a null-terminated string that contains the name of the document file associated with the object.

Visual Basic Reference

HRESULT put_FileName(
  BSTR newVal  // new value for file name
);

Parameters

newVal

[in] Specifies the new value to assign to the file name to transmit. This parameter must contain the fully qualified path and file name of a valid local or remote file. The file must be a properly registered file type, and the fax server must be able to access the file.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

The FileName property is required to send a fax transmission using a call to the IFaxDoc::Send method. For more information, see Transmitting Faxes.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxDoc, IFaxDoc::get_FileName