IFaxTiff::get_RecipientNumber method (faxcom.h)

Article
02/22/2024

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.

This property is read-only.

Syntax

HRESULT get_RecipientNumber(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

A fax client application must set the Image property before retrieving another property for a FaxTiff object.

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 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 "Unavailable".

The RecipientNumber property is a string that represents the fax number of the fax recipient, if it is available. If the information is not available, RecipientNumber is an empty string.

The 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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	faxcom.h
DLL	Faxcom.dll

Share via