IFaxTiff::get_Routing method (faxcom.h)

Article
02/22/2024

Retrieves the Routing property for a FaxTiff object. The Routing property is a null-terminated string that contains the inbound routing string for a specified fax file.

This property is read-only.

Syntax

HRESULT get_Routing(
  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 routing information is specific to a fax service provider (FSP); for example, direct inward dialing (DID) routing digits.

The get_Routing method sets the pVal parameter to optional inbound routing information specified for the fax file, if it is available. If the information is not available, the method returns "Unavailable".

The Routing property is a string that represents optional inbound routing information specified for the fax file, if it is available. If the information is not available, Routing is an empty string.

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