FaxRegisterRoutingExtensionW function (winfax.h)

The FaxRegisterRoutingExtension function registers a fax routing extension DLL with the fax service. The function configures the fax service registry to use the new routing extension DLL.

Syntax

WINFAXAPI BOOL FaxRegisterRoutingExtensionW(
  [in] HANDLE                              FaxHandle,
  [in] LPCWSTR                             ExtensionName,
  [in] LPCWSTR                             FriendlyName,
  [in] LPCWSTR                             ImageName,
  [in] PFAX_ROUTING_INSTALLATION_CALLBACKW CallBack,
  [in] LPVOID                              Context
);

Parameters

[in] FaxHandle

Type: HANDLE

Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

[in] ExtensionName

Type: LPCWSTR

Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

[in] FriendlyName

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character string to associate with the fax routing extension DLL. This is the routing extension's user-friendly name, suitable for display.

[in] ImageName

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character 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%.

[in] CallBack

Type: PFAX_ROUTING_INSTALLATION_CALLBACK

Pointer to a FaxRoutingInstallationCallback function that installs a fax routing method for the specified fax routing extension DLL. The FaxRegisterRoutingExtension function calls the FaxRoutingInstallationCallback function multiple times, until it returns a value of zero, indicating that all routing methods in the fax routing extension DLL have been registered.

[in] Context

Type: LPVOID

Pointer to a variable that contains application-specific context information or an application-defined value. FaxRegisterRoutingExtension passes this data to the FaxRoutingInstallationCallback function.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Remarks

FaxRegisterRoutingExtension calls the FaxRoutingInstallationCallback function once for each fax routing method in the fax routing extension DLL.

Because the FaxRegisterRoutingExtension function modifies the registry, the user, generally a system administrator, must have write access to the HKEY_LOCAL_MACHINE registry key.

You must restart the fax service to use a fax routing method exported by a fax routing extension you install using FaxRegisterRoutingExtension.

For more information about the steps required to register with the fax service, see Registration of a Fax Routing Extension.

Requirements

See also

Fax Service Client API Functions

Fax Service Client API for Windows 2000

FaxConnectFaxServer

FaxRoutingInstallationCallback