FAX_ROUTING_INSTALLATION_CALLBACK

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

The PFAX_ROUTING_INSTALLATION_CALLBACK data type is a pointer to a FAX_ROUTING_INSTALLATION_CALLBACK function.

BOOL CALLBACK FAX_ROUTING_INSTALLATION_CALLBACK(
  HANDLE FaxHandle,     //handle to the fax server
  LPVOID Context,       //pointer to context information
  LPWSTR MethodName,    //pointer to fax routing method internal name
  LPWSTR FriendlyName,  //pointer to fax routing method
                        //  user-friendly name
  LPWSTR FunctionName,  //pointer to fax routing method function name
  LPWSTR Guid           //pointer to GUID that 
                        //  identifies the fax routing method
);

Parameters

FaxHandle

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

Context

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

MethodName

[in/out] 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.

FriendlyName

[in/out] 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.

FunctionName

[in/out] 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.

Guid

[in/out] 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 Values

The FAX_ROUTING_INSTALLATION_CALLBACK 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 FAX_ROUTING_INSTALLATION_CALLBACK should be terminated. To get extended error information, call GetLastError.

Remarks

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

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Unicode: Declared as Unicode and ANSI prototypes.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxRegisterRoutingExtension, FaxConnectFaxServer