Platform SDK: Fax Services

IFaxServer::put_DiscountRateStartHour

The IFaxServer::put_DiscountRateStartHour method changes the DiscountRateStartHour property for a FaxServer object. The DiscountRateStartHour property is a number that represents the hour the discount period begins. The discount period applies only to outgoing fax transmissions.

Visual Basic Reference

HRESULT put_DiscountRateStartHour(
  SHORT newVal  // new value for hour discount rate begins
);

Parameters

newVal
[in] Specifies the new value to assign to the DiscountRateStartHour property. Valid values for this parameter are 0 through 23.

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 save on transmission costs, a user can queue a fax job and request that the fax server send the transmission during the discount rate period. For more information, see IFaxDoc::put_DiscountSend.

The DiscountRateStartHour, DiscountRateStartMinute, DiscountRateEndHour, and DiscountRateEndHour properties represent local time.

If the time the discount rate period ends is less than the time the discount rate period begins, the discount rate period extends into the next day. For example, if the discount rate period begins at 9:00 P.M. and ends at 7:00 A.M., the discount rate period begins in the evening and continues until the morning of the following day.

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