FaxRouteDeleteFile

A fax routing method calls the FaxRouteDeleteFile callback function to delete a file from the fax file list associated with a received fax document.

LONG WINAPI FaxRouteDeleteFile(
  DWORD JobId,       // fax job identifier 
  LPCWSTR FileName   // pointer to the file name to delete 
);

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.

FileName

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

Return Values

If the function succeeds, the return value is the file number of the file deleted from 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

A fax routing method can use the FaxRouteDeleteFile function to remove a file that a different routing method added to the fax file list. For more information, see Fax File Lists.

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

The PFAXROUTEDELETEFILE data type is a pointer to a FaxRouteDeleteFile function.

Note  A fax routing method cannot remove the initial Tagged Image File Format, Class F for facsimile (TIFF Class F) file from the fax file list. For information about TIFF files, see Fax Image Format.

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, FaxRouteAddFile, FaxRouteGetFile, FaxRouteInitialize