PFAXROUTEDELETEFILE callback function (faxroute.h)
A fax routing method calls the FaxRouteDeleteFile callback function to delete a file from the fax file list associated with a received fax document.
Syntax
PFAXROUTEDELETEFILE Pfaxroutedeletefile;
LONG Pfaxroutedeletefile(
[in] DWORD JobId,
[in] LPCWSTR FileName
)
{...}
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 delete from the fax file list associated with the received fax document.
Return value
Type: LONG
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, the fax service calls 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 defines a pointer to a FaxRouteDeleteFile function.
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 |
See also
Fax Routing Extension Application Programming Interface Overview