FaxRouteModifyRoutingData

A fax routing method calls the FaxRouteModifyRoutingData callback function to modify the routing data for a subsequent fax routing method.

BOOL WINAPI FaxRouteModifyRoutingData(
  DWORD JobId,           // fax job identifier 
  LPCWSTR RoutingGuid,   // pointer to the GUID for the routing method
  LPBYTE RoutingData,    // array that contains routing data
  DWORD RoutingDataSize  // size of routing data array
);

Parameters

JobId

[in] Specifies a unique number that identifies the fax job that received the fax document.

RoutingGuid

[in] Pointer to a constant null-terminated Unicode character string that specifies the GUID of the fax routing method to modify. For more information, see Registering a Fax Routing Method.

RoutingData

[in] Pointer to a buffer that contains additional routing data defined by the routing extension. For more information, see the following Remarks section.

The fax routing method that calls the FaxRouteModifyRoutingData function and the routing method specified by the RoutingGuid parameter must interpret the data in the RoutingData parameter.

RoutingDataSize

[in] Specifies a DWORD variable that is the size, in bytes, of the buffer pointed to by the RoutingData parameter.

Return Values

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The fax service passes a pointer to the FaxRouteModifyRoutingData function when the fax service calls FaxRouteInitialize. The service passes the pointer in a FAX_ROUTE_CALLBACKROUTINES structure.

The PFAXROUTEMODIFYROUTINGDATA data type is a pointer to a FaxRouteModifyRoutingData function.

A fax routing method can call the FaxRouteModifyRoutingData callback function to change the routing information for a subsequent routing method. The function does this by modifying the RoutingInfoData member of the FAX_ROUTE structure that applies to the subsequent method. This allows a fax routing extension to retrieve user-defined routing data and to provide additional callback information to a different routing method. When the subsequent routing method executes, it processes the received fax transmission using the modified routing data.

The fax routing method specified by the RoutingGuid parameter must have a lower priority and must run after the calling routing method. The priority level determines the relative order in which the fax service calls the fax routing methods when the service receives a fax document. Call the FaxEnumGlobalRoutingInfo function to retrieve the priority for a routing method. Call the FaxSetGlobalRoutingInfo function to change the priority of a routing method.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxroute.h.
  Import Library: User-defined.

See Also

Fax Routing Extension Application Programming Interface Overview, Fax Routing Extension Functions, FAX_ROUTE_CALLBACKROUTINES, FaxEnumGlobalRoutingInfo, FaxSetGlobalRoutingInfo, FaxRouteMethod, FAX_ROUTE, FaxRouteInitialize