IFaxTiff::get_RecipientName method (faxcom.h)

Retrieves the RecipientName property for a FaxTiff object. The RecipientName property is a null-terminated string that contains the name of the recipient for the specified fax file.

This property is read-only.

Syntax

HRESULT get_RecipientName(
  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 get_RecipientName method sets the pVal parameter to the name of the fax recipient, if it is available. If the information is not available, the method returns "Unavailable".

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

The get_RecipientName 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

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IFaxTiff

IFaxTiff::get_Image

SysFreeString