FaxRouteInitialize

The fax service calls the FaxRouteInitialize function once, each time the service starts, to initialize the fax routing extension DLL. Each fax routing extension DLL must export the FaxRouteInitialize function.

BOOL WINAPI FaxRouteInitialize(
  HANDLE HeapHandle,  // handle to heap for memory allocation
  PFAX_ROUTE_CALLBACKROUTINES FaxRouteCallbackRoutines 
                      //pointer to structure that contains 
                      //pointers to callback functions
);

Parameters

HeapHandle

[in] Handle to an initialized heap. The fax routing extension DLL must use the Win32 heap functions to allocate all memory from this heap.

FaxRouteCallbackRoutines

[in] Pointer to a FAX_ROUTE_CALLBACKROUTINES structure that contains pointers to the callback functions the fax service supplies. The structure contains pointers to the FaxRouteAddFile, FaxRouteDeleteFile, FaxRouteGetFile, FaxRouteEnumFiles, and FaxRouteModifyRoutingData functions.

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

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, the fax service calls GetLastError.

Remarks

The fax routing extension DLL should not perform provider-specific initialization when the fax service calls the DllMain function. Instead, the extension should do this when the fax service calls the FaxRouteInitialize function.

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

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, FaxRouteAddFile, FaxRouteDeleteFile, FaxRouteGetFile, FaxRouteEnumFiles, FaxRouteModifyRoutingData, FAX_ROUTE_CALLBACKROUTINES, DllMain