PFAXROUTEENUMFILE callback function (faxroute.h)

Article
10/13/2021

The FaxRouteEnumFile callback function receives the file names in the fax file list associated with a received fax document. This function receives a file name in the fax file list associated with a received fax document, and executes a procedure defined by the routing extension. It can return a nonzero value to proceed to the next file name in the fax file list, or zero to stop FaxRouteEnumFiles.

FaxRouteEnumFile is a placeholder for a function name defined by the fax routing extension DLL. The PFAXROUTEENUMFILE data type is a pointer to a FaxRouteEnumFile function.

Syntax

PFAXROUTEENUMFILE Pfaxrouteenumfile;

BOOL Pfaxrouteenumfile(
  [in]      DWORD JobId,
  [in]      GUID *GuidOwner,
  [in]      GUID *GuidCaller,
  [in]      LPCWSTR FileName,
  [in, out] PVOID Context
)
{...}

Parameters

[in] JobId

Type: DWORD

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

[in] GuidOwner

Type: GUID*

Pointer to the GUID associated with the fax routing method that added the file to the fax file list. (This file is specified by the FileName parameter.)

[in] GuidCaller

Type: GUID*

Pointer to the GUID associated with the fax routing method that called the FaxRouteEnumFiles function. (FaxRouteEnumFiles passes a pointer to the FaxRouteEnumFile function.) Note that this parameter has the same value as the Guid parameter of FaxRouteEnumFiles. The GuidCaller parameter can be NULL.

[in] FileName

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character string. The fax service sets this variable to the fully qualified path and name of one file in the fax file list associated with the received fax document.

[in, out] Context

Type: PVOID

Pointer to an extension-defined value supplied by the fax routing method identified by the GuidCaller parameter. This is an opaque value that the FaxRouteEnumFiles function passes to FaxRouteEnumFile.

Return value

Type: BOOL

The function returns a nonzero value to continue enumeration, or zero to stop enumeration.

Remarks

The fax routing extension DLL must register the FaxRouteEnumFile callback function by passing its address to the FaxRouteEnumFiles function.

For more information, see 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