IFaxDoc::get_DiscountSend

The IFaxDoc::get_DiscountSend method retrieves the DiscountSend property for a FaxDoc object. The DiscountSend property is a Boolean value that indicates whether the fax server transmits faxes during the discount period.

Visual Basic Reference

HRESULT get_DiscountSend(
  BOOL *pVal  // receives send at discount rate flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax server sends documents during the transmission discount period. If this parameter is equal to TRUE, transmission will be during the discount period. A value of FALSE indicates that the fax service sends faxes immediately. For more information, see the following Remarks section.

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 determine the period during which the discount rate applies, you can call the following IFaxServer methods: IFaxServer::get_DiscountRateStartMinute, IFaxServer::get_DiscountRateEndMinute, IFaxServer::get_DiscountRateStartHour, and IFaxServer::get_DiscountRateEndHour.

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, IFaxDoc, IFaxDoc::put_DiscountSend, IFaxServer::get_DiscountRateStartHour, IFaxServer::get_DiscountRateStartMinute, IFaxServer::get_DiscountRateEndHour, IFaxServer::get_DiscountRateEndMinute