IFaxPort::get_Rings

The IFaxPort::get_Rings method retrieves the Rings property for a FaxPort object. The Rings property represents the number of rings an incoming fax call should wait before the fax port answers the call.

Visual Basic Reference

HRESULT get_Rings(
  LONG *pVal  // receives number of rings before answer
);

Parameters

pVal

[out] Pointer to a variable that indicates the number of rings an incoming fax call should wait before the specified port answers the call. Valid values for this parameter are 1 through 99.

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

The fax server ignores the Rings property unless the specified fax port is enabled to receive faxes.

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, IFaxPort, IFaxPorts, IFaxPort::put_Rings, IFaxPort::get_Receive