FaxRouteEnumFiles

A fax routing method calls the FaxRouteEnumFiles callback function to enumerate the files in the fax file list associated with a received fax document. FaxRouteEnumFiles passes a pointer to the FaxRouteEnumFile callback function.

BOOL WINAPI FaxRouteEnumFiles(
  DWORD JobId,     // fax job identifier 
  GUID *Guid,      // pointer to the GUID for the routing method 
  PFAXROUTEENUMFILE FileEnumerator, 
                   // pointer to file enumeration callback function
  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.

Guid

[in] Pointer to a null-terminated Unicode character string that contains the GUID for the fax routing method. For more information, see Registering a Fax Routing Method.

FileEnumerator

[in] Pointer to a FaxRouteEnumFile callback function defined by the fax routing extension. FaxRouteEnumFile receives the file names in the fax file list associated with the received fax document.

Context

[in/out] Pointer to an extension-defined value that FaxRouteEnumFiles passes to the FaxRouteEnumFile function. The fax routing method can define this value.

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, call GetLastError.

Remarks

The fax service passes a pointer to the FaxRouteEnumFiles callback function when the fax service calls the FaxRouteInitialize function. The service passes the pointer in a FAX_ROUTE_CALLBACKROUTINES structure.

The PFAXROUTEENUMFILES data type is a pointer to a FaxRouteEnumFiles function.

The fax routing extension DLL must supply the FaxRouteEnumFile function specified by the FileEnumerator parameter. The fax service calls FaxRouteEnumFile to enumerate the files in the fax file list for the fax routing method. The fax service calls FaxRouteEnumFile once for each file in the fax file list.

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, FAX_ROUTE_CALLBACKROUTINES, FaxRouteEnumFile, FaxRouteInitialize