FaxRouteEnumFile

A FaxRouteEnumFile callback function is a placeholder for a function name defined by the fax routing extension DLL.

FaxRouteEnumFile receives the file names in the fax file list associated with a received fax document. This function supplies the file names that result from a call by a fax routing method to the FaxRouteEnumFiles callback function. The fax service calls FaxRouteEnumFile once for each file in the fax file list.

BOOL WINAPI FaxRouteEnumFile(
  DWORD JobId,      // fax job identifier 
  GUID *GuidOwner,  // pointer to GUID of the routing method
                    //   that added file
  GUID *GuidCaller, // pointer to GUID of calling routing method
  LPCWSTR FileName, // pointer to a file name in the fax file list
  PVOID Context     // pointer to an extension-defined value 
);

Parameters

JobId

[in] Specifies a unique number that identifies the fax job that received the fax document. For information about fax jobs, see Fax Job Overview.

GuidOwner

[in] 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.)

GuidCaller

[in] 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.

FileName

[in] 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.

Context

[in/out] 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 Values

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 callback function. The PFAXROUTEENUMFILE data type is a pointer to a FaxRouteEnumFile function.

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