Return the scheduled start time of the recurring event handle.

Synopsis

Declared in <bdlmt_eventscheduler.h>

bsl::optional<bsls::TimeInterval>
scheduledEventTime(RecurringEventHandle const& handle) const;

Description

Return the scheduled starting time of the recurring event having the specified handle. If the handle is invalid, or the event has already been canceled, return an optional without a value.

Return Value

the scheduled start time, or an empty optional if invalid

Parameters

Name

Description

handle

recurring event whose scheduled time is returned

Created with MrDocs