IFaxDoc::put_FaxNumber

The IFaxDoc::put_FaxNumber method changes the FaxNumber property of a FaxDoc object. The FaxNumber property is a null-terminated string that contains the fax number to which the fax server will send the fax transmission.

Visual Basic Reference

HRESULT put_FaxNumber(
  BSTR newVal  // new value for recipient's fax number
);

Parameters

newVal

[in] Specifies the new value to assign to the FaxNumber property. For more information, see the following Remarks section.

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 FaxNumber property is required to send a fax transmission using a call to the IFaxDoc::Send method, unless you specify either the CallHandle property or the ConnectionObject property. For more information, see Transmitting Faxes.

If you specify the fax number with a canonical format, the fax service uses the telephony user preferences to send the transmission. These preferences are entered under the Dialing Properties tab accessed through the Telephony icon in Control Panel. If you do not specify a canonical telephone number, the fax service dials the literal string of numbers entered by the user to send the transmission. For more information, see Canonical Addresses in the TAPI documentation.

The recipient's fax number can appear on the cover page.

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::Send, IFaxDoc::get_FaxNumber