FaxDevInitialize function (faxdev.h)

The fax service calls the FaxDevInitialize function each time the service starts, after it loads the fax service provider (FSP) DLL. Each FSP must export the FaxDevInitialize function.

Syntax

BOOL FaxDevInitialize(
  [in]  HLINEAPP              LineAppHandle,
  [in]  HANDLE                HeapHandle,
  [out] PFAX_LINECALLBACK     *LineCallbackFunction,
  [in]  PFAX_SERVICE_CALLBACK FaxServiceCallback
);

Parameters

[in] LineAppHandle

Type: HLINEAPP

Specifies a handle to the fax service's registration with TAPI. For more information, see the TAPI 2.x lineInitializeEx function.

[in] HeapHandle

Type: HANDLE

Specifies a handle to a heap that the FSP must use for all memory allocations.

[out] LineCallbackFunction

Type: PFAX_LINECALLBACK*

Pointer to a variable that receives a pointer to a TAPI line callback function.

[in] FaxServiceCallback

Type: PFAX_SERVICE_CALLBACK

Pointer to a service callback function. Although this function is not used currently, this feature is expected to be available in a future version of the fax service and will provide functionality from the fax service to the FSP.

Return value

Type: BOOL

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

If the function fails, the return value is zero. In this case, the current instance of the fax service does not use this FSP. All devices that this FSP supports are unable to send or receive faxes. To get extended error information, the fax service calls GetLastError.

Remarks

The FSP must respond to the FaxDevInitialize function by performing any necessary initialization.

The FSP must supply the FaxLineCallback function specified by the LineCallbackFunction parameter. The fax service calls this function when it needs to deliver a TAPI event to the FSP.

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 faxdev.h

See also

Fax Service Provider Functions

FaxDevStartJob

FaxDevVirtualDeviceCreation

FaxLineCallback

Using the Fax Service Provider API

lineInitializeEx