IFaxServer::get_DirtyDays

The IFaxServer::get_DirtyDays method retrieves the DirtyDays property for a FaxServer object. The DirtyDays property is the number of days the fax server retains an unsent job in the fax job queue.

Visual Basic Reference

HRESULT get_DirtyDays(
  LONG *pVal  // receives days to keep unsent fax in queue
);

Parameters

pVal

[out] Pointer to a LONG variable that indicates the number of days the fax server retains an unsent job in the fax job queue. A value of – 1 indicates that the fax server should not remove the job from the job queue.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

To minimize the amount of space unsent jobs use, the fax server removes unsent jobs after the number of days specified by the DirtyDays property have elapsed.

A transmission might not be sent for various reasons. Examples are if an invalid fax number is specified, or when the sending device receives a busy signal multiple times.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxServer, IFaxServer::put_DirtyDays