Add time components if the result remains a valid datetime.

Synopsis

Declared in <bdlt_datetime.h>

int
addTimeIfValid(
    bsls::Types::Int64 hours,
    bsls::Types::Int64 minutes = 0,
    bsls::Types::Int64 seconds = 0,
    bsls::Types::Int64 milliseconds = 0,
    bsls::Types::Int64 microseconds = 0);

Description

Add the specified number of hours, and the optionally specified number of minutes, seconds, milliseconds, and microseconds to the value of this object, adjusting the "date" part of this object accordingly, if the resulting value is in the valid range for a Datetime object. Unspecified trailing optional parameters default to 0. If 24 == hour() on entry, set the hour attribute to 0 before performing the addition. Return 0 on success, and a non‐zero value (with no effect) otherwise. Note that each argument independently may be positive, negative, or 0.

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

hours

number of hours to add

minutes

number of minutes to add (default 0)

seconds

number of seconds to add (default 0)

milliseconds

number of milliseconds to add (default 0)

microseconds

number of microseconds to add (default 0)

Created with MrDocs