PFAXROUTEADDFILE callback function (faxroute.h)

Article
02/22/2024

A fax routing method calls the FaxRouteAddFile callback function to add a file to the fax file list associated with a received fax document.

Syntax

PFAXROUTEADDFILE Pfaxrouteaddfile;

LONG Pfaxrouteaddfile(
  [in] DWORD JobId,
  [in] LPCWSTR FileName,
  [in] GUID *Guid
)
{...}

Parameters

[in] JobId

Type: DWORD

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

[in] FileName

Type: LPCWSTR

Pointer to a constant null-terminated Unicode character string. The string contains the fully qualified path and name of the file to add to the fax file list associated with the received fax document.

[in] Guid

Type: GUID*

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

Return value

Type: LONG

If the function succeeds, the return value is the file number of the file added to the fax file list associated with the received fax.

If the function fails, the return value is 1. To get extended error information, the fax service calls GetLastError, described in MSDN.

Remarks

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

The PFAXROUTEADDFILE data type defines a pointer to a FaxRouteAddFile 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