FaxRouteAddFile

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

LONG WINAPI FaxRouteAddFile(
  DWORD JobId,      // fax job identifier 
  LPCWSTR FileName, // pointer to the file name to add 
  GUID *Guid        // pointer to the GUID for the routing method 
);

Parameters

JobId

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

FileName

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

Guid

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

Return Values

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

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 is a pointer to a FaxRouteAddFile 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, FaxRouteDeleteFile, FAX_ROUTE_CALLBACKROUTINES, FaxRouteGetFile, FaxRouteInitialize