FAX_ROUTE_CALLBACKROUTINES structure (faxroute.h)

The FAX_ROUTE_CALLBACKROUTINES structure contains pointers to callback functions the fax service provides. A fax routing extension's routing methods can call these callback functions to manage the files in the fax file list associated with a received fax document.

Syntax

typedef struct _FAX_ROUTE_CALLBACKROUTINES {
  DWORD                      SizeOfStruct;
  PFAXROUTEADDFILE           FaxRouteAddFile;
  PFAXROUTEDELETEFILE        FaxRouteDeleteFile;
  PFAXROUTEGETFILE           FaxRouteGetFile;
  PFAXROUTEENUMFILES         FaxRouteEnumFiles;
  PFAXROUTEMODIFYROUTINGDATA FaxRouteModifyRoutingData;
} FAX_ROUTE_CALLBACKROUTINES, *PFAX_ROUTE_CALLBACKROUTINES;

Members

SizeOfStruct

Type: DWORD

Specifies the size, in bytes, of the FAX_ROUTE_CALLBACKROUTINES structure. The fax service sets this member to sizeof(FAX_ROUTE_CALLBACKROUTINES). For information about backward compatibility, see the following Remarks section.

FaxRouteAddFile

Type: PFAXROUTEADDFILE

Pointer to a FaxRouteAddFile callback function that a fax routing method uses to add a file to the fax file list associated with a received fax document.

FaxRouteDeleteFile

Type: PFAXROUTEDELETEFILE

Pointer to a FaxRouteDeleteFile callback function that a fax routing method uses to delete a file from the fax file list associated with a received fax document.

FaxRouteGetFile

Type: PFAXROUTEGETFILE

Pointer to a FaxRouteGetFile callback function that a fax routing method uses to retrieve a specific file name from the fax file list associated with a received fax document.

FaxRouteEnumFiles

Type: PFAXROUTEENUMFILES

Pointer to a FaxRouteEnumFiles callback function that a fax routing method uses to enumerate the files in the fax file list associated with a received fax document.

FaxRouteModifyRoutingData

Type: PFAXROUTEMODIFYROUTINGDATA

Pointer to a FaxRouteModifyRoutingData callback function that a fax routing method uses to modify the routing data associated with a subsequent fax routing method.

Remarks

The fax routing extension DLL must store the pointers to these callback functions in a global variable for later use.

If the SizeOfStruct member is greater than sizeof(FAX_ROUTE_CALLBACKROUTINES), this indicates that the FAX_ROUTE_CALLBACKROUTINES structure has been updated by Microsoft, and your application is using an earlier version. To maintain backward compatibility, changes will be appended to the original prototype of the FAX_ROUTE_CALLBACKROUTINES structure. For example, new members for additional callback functions will be added sequentially after the FaxRouteModifyRoutingData member.

For more information, see Fax Routing Extension Registration and Fax File Lists.

Requirements

See also

Fax Routing Extension Application Programming Interface Overview

Fax Routing Extension Structures

FaxRouteAddFile

FaxRouteDeleteFile

FaxRouteEnumFiles

FaxRouteGetFile

FaxRouteModifyRoutingData