PFAX_ROUTING_INSTALLATION_CALLBACKW callback function (winfax.h)

The FaxRoutingInstallationCallback function is a library-defined callback function that the FaxRegisterRoutingExtension function calls to install a fax routing extension DLL. FaxRegisterRoutingExtension calls the FaxRoutingInstallationCallback function multiple times, once for each fax routing method the fax routing extension exports.

Syntax

PFAX_ROUTING_INSTALLATION_CALLBACKW PfaxRoutingInstallationCallbackw;

BOOL PfaxRoutingInstallationCallbackw(
  [in]  HANDLE FaxHandle,
  [in]  LPVOID Context,
  [out] LPWSTR MethodName,
  [out] LPWSTR FriendlyName,
  [out] LPWSTR FunctionName,
  [out] LPWSTR Guid
)
{...}

Parameters

[in] FaxHandle

Type: HANDLE

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

[in] Context

Type: LPVOID

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

[out] MethodName

Type: LPWSTR

Pointer to a variable to receive a null-terminated Unicode character string that specifies the internal name of the fax routing method. The string must not exceed 100 characters. For information about fax routing methods, see About the Fax Routing Extension API.

[out] FriendlyName

Type: LPWSTR

Pointer to a variable to receive a null-terminated Unicode character string that specifies the user-friendly name to display for the fax routing method. The string must not exceed 100 characters.

[out] FunctionName

Type: LPWSTR

Pointer to a variable to receive a null-terminated Unicode character string. The string contains the name of the exported function that executes the specified fax routing procedure. The string must not exceed 100 characters.

[out] Guid

Type: LPWSTR

Pointer to a variable to receive a null-terminated Unicode character string. The string specifies the GUID that uniquely identifies the fax routing method of interest.

Return value

Type: BOOL

The FaxRoutingInstallationCallback function returns a value of nonzero to indicate that the FaxRegisterRoutingExtension function should register the fax routing method for the fax routing extension, using the data pointed to by the parameters.

The function returns a value of zero to indicate that there are no more fax routing methods to register, and calls to FaxRoutingInstallationCallback should be terminated.

Remarks

The PFAX_ROUTING_INSTALLATION_CALLBACKW data type is a pointer to a FaxRoutingInstallationCallback function.

A fax client application specifies the FaxRoutingInstallationCallback function by passing its address when it calls the FaxRegisterRoutingExtension function. For more information, see Registration of a Fax Routing Extension.

For information about fax routing extensions, see About the Fax Routing Extension API.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	winfax.h

See also

Fax Service Client API Functions

Fax Service Client API for Windows 2000

FaxConnectFaxServer

FaxRegisterRoutingExtension