IFaxStatus::get_RoutingString method (faxcom.h)

Article
02/22/2024

Retrieves the RoutingString property for the FaxStatus object of a parent FaxPort object. The RoutingString property is a null-terminated string that contains routing information for inbound fax transmissions that is specific to a fax service provider.

This property is read-only.

Syntax

HRESULT get_RoutingString(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

The IFaxStatus::get_RoutingString method sets the pVal parameter to optional inbound routing information, if it is available. If the information is not available, the method returns an empty string.

The IFaxStatus::get_RoutingString 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