IFaxTiff::get_RecipientNumber

The IFaxTiff::get_RecipientNumber method retrieves the RecipientNumber property for a FaxTiff object. The RecipientNumber property is a null-terminated string that contains the fax number to which a fax was transmitted.

A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.

Visual Basic Reference

HRESULT get_RecipientNumber(
  BSTR *pVal  // receives recipient number string
);

Parameters

pVal

[out] Pointer to a string that contains the fax number for the recipient of the fax document.

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 RecipientNumber property has meaning only for outbound fax transmissions. This is because the Csid property and the RecipientNumber property are identical for inbound faxes.

The IFaxTiff::get_RecipientNumber method sets the pVal parameter to the fax number of the fax recipient, if it is available. If the information is not available, the method returns an empty string.

The IFaxTiff::get_RecipientNumber 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, IFaxTiff, IFaxTiff::put_Image, IFaxTiff::get_Csid, SysFreeString