IFaxStatus::get_RoutingString

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

Visual Basic Reference

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

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the routing information for an inbound fax transmission. Note that the RoutingString property is valid only if the Receive property is equal to TRUE.

Routing information is specific to a fax service provider; for example, direct inward dialing (DID) routing digits. A fax client application can expect this parameter to be NULL if the fax service is transmitting a document, or if the routing string has not yet been set for an incoming fax transmission.

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

  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, IFaxStatus, IFaxStatus::get_Receive, IFaxPorts, IFaxPort, SysFreeString