IFaxServer::get_Retries

The IFaxServer::get_Retries method retrieves the Retries property for a FaxServer object. The Retries property is a value that represents the number of times the fax server attempts to retransmit an outgoing fax when the initial transmission fails.

Visual Basic Reference

HRESULT get_Retries(
  LONG *pVal  // receives maximum number of retransmission attempts
);

Parameters

pVal

[out] Pointer to a LONG variable that indicates the number of times the fax server attempts to retransmit an outgoing fax when the initial transmission fails. A value of zero indicates that the fax server should not attempt to retransmit an outbound job if the first transmission fails.

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

A transmission might not be sent on the first attempt for various reasons. For example, the sending device may receive a busy signal.

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_Retries