| Platform SDK: Fax Services |
The IFaxTiff::get_Routing method 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.
A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.
HRESULT get_Routing( BSTR *pVal // receives inbound routing string );
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.
The routing information is specific to a fax service provider; for example, direct inward dialing (DID) routing digits.
The IFaxTiff::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 an empty string.
The IFaxTiff::get_Routing 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.
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in faxcom.h.
Import Library: Included as a resource in faxcom.dll.
Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxTiff, IFaxTiff::put_Image, SysFreeString