IFaxRoutingMethod::get_RoutingData

The IFaxRoutingMethod::get_RoutingData method retrieves the RoutingData property for a FaxRoutingMethod object. The RoutingData property is a null-terminated string that contains the routing string for an incoming fax transmission.

Visual Basic Reference

HRESULT get_RoutingData(
  BSTR *pVal  // receives inbound routing data string
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the routing string for an incoming fax transmission. The string must be of the form:

Canonical-Phone-Number[|Additional-Routing-Info]

where Canonical-Phone-Number is defined in Canonical Addresses in the TAPI documentation; and the format of Additional-Routing-Info is defined by the recommendation of the standards body of the International Telecommunications Union (ITU) from Study Group 8 (SG8). This recommendation is currently known as "T.Routing."

Return Values

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.

Remarks

The IFaxRoutingMethod::get_RoutingData 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

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxRoutingMethod, IFaxRoutingMethods, SysFreeString