FaxRouteInitialize function (faxroute.h)
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.
Syntax
BOOL FaxRouteInitialize(
[in] HANDLE HeapHandle,
[in] PFAX_ROUTE_CALLBACKROUTINES FaxRouteCallbackRoutines
);
Parameters
[in] HeapHandle
Type: HANDLE
Handle to an initialized heap. The fax routing extension DLL must use the Win32 heap functions to allocate all memory from this heap.
[in] FaxRouteCallbackRoutines
Type: PFAX_ROUTE_CALLBACKROUTINES
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 value
Type: BOOL
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional, Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | faxroute.h |
See also
Fax Routing Extension Application Programming Interface Overview