IFaxJob::get_FaxNumber

The IFaxJob::get_FaxNumber method retrieves the FaxNumber property for a FaxJob object. The FaxNumber property is a null-terminated string that contains the fax number to which the fax server will transmit the fax job. The FaxNumber property applies only to outgoing fax transmissions.

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 contain a number in canonical format. For more information, see 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

A fax number is only available for faxes that have a Type property equal to JT_SEND. If the fax number is not available, the IFaxJob::get_FaxNumber method returns an empty string.

The IFaxJob::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.

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, IFaxJob, IFaxJobs, SysFreeString, IFaxJob::get_Type