IFaxDoc::get_EmailAddress

The IFaxDoc::get_EmailAddress method retrieves the EmailAddress property of a FaxDoc object. The EmailAddress property is a null-terminated string that contains the e-mail address of the sender of the fax transmission.

Visual Basic Reference

HRESULT get_EmailAddress(
  BSTR *pVal  // receives fax sender's e-mail address
);

Parameters

pVal

[out] Pointer to a string that contains the e-mail address of the user who sent the fax transmission. The fax server uses the EmailAddress property to send delivery reports (DRs) and non-delivery reports (NDRs) to the sender of the transmission. The e-mail address must be a valid address or alias in the Microsoft Exchange Server global address list (GAL).

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 IFaxDoc::get_EmailAddress 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 Enabling MAPI Functionality in a Fax Client Application and 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_EmailAddress, SysFreeString