IFaxDoc::get_FileName

The IFaxDoc::get_FileName method retrieves 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 get_FileName(
  BSTR *pVal  // receives file name
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the fully qualified path and name of the file to transmit. This parameter can contain any valid local or remote file name. 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.

The IFaxDoc::get_FileName method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

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::put_FileName, SysFreeString