IFaxServer::RegisterInboundRoutingExtension method (faxcomex.h)

The IFaxServer::RegisterInboundRoutingExtension method registers a fax inbound routing extension with the fax service. Registration takes place after the fax service restarts.

Syntax

HRESULT RegisterInboundRoutingExtension(
  BSTR    bstrExtensionName,
  BSTR    bstrFriendlyName,
  BSTR    bstrImageName,
  VARIANT vMethods
);

Parameters

bstrExtensionName

Type: BSTR

String that specifies the internal name of the fax routing extension DLL.

bstrFriendlyName

Type: BSTR

String to associate with the fax routing extension DLL. This is the routing extension's user-friendly name, suitable for display.

bstrImageName

Type: BSTR

String that specifies the full path and file name for the fax routing extension DLL. The path can include valid environment variables, for example, %SYSTEMDRIVE% and %SYSTEMROOT%.

vMethods

Type: VARIANT

VARIANT that specifies a safearray of BSTRs. The array must be unidimensional, it cannot be empty, and it must have a lower limit of zero. Each item (string) in the array must identify a routing method. The string must have the following format: Method name; Friendly name; Function Name; Method GUID

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Only an administrator can register a routing extension. Also, this method works only on the local fax server.

This property is not supported in Windows XP, and will return the error: FAX_E_NOT_SUPPORTED_ON_THIS_SKU.

To use this method, a user must have the farMANAGE_CONFIG access right.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxcomex.h
DLL	Fxscomex.dll

See also

FaxServer

IFaxServer