IFaxDoc::get_FaxNumber

The IFaxDoc::get_FaxNumber method retrieves 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 get_FaxNumber(
  BSTR *pVal  // receives recipient's fax number
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the fax number of the recipient of the transmission. The string can specify a number in canonical format. For more information, see the Remarks section of the IFaxDoc::put_FaxNumber topic, and Canonical Addresses in the TAPI documentation.

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.

The IFaxDoc::get_FaxNumber 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.

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