PFAXROUTEENUMFILES callback function (faxroute.h)

Article
02/22/2024

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

FaxRoutingMethod passes a pointer to the FaxRouteEnumFile callback function if it calls FaxRouteEnumFiles.

Syntax

PFAXROUTEENUMFILES Pfaxrouteenumfiles;

BOOL Pfaxrouteenumfiles(
  [in]      DWORD JobId,
  [in]      GUID *Guid,
  [in]      PFAXROUTEENUMFILE FileEnumerator,
  [in, out] PVOID Context
)
{...}

Parameters

[in] JobId

Type: DWORD

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

[in] Guid

Type: GUID*

Pointer to a null-terminated Unicode character string that contains the GUID for the fax routing method.

[in] FileEnumerator

Type: PFAXROUTEENUMFILE

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.

[in, out] Context

Type: PVOID

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

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, described in MSDN.

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 defines 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

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