[#BloombergLP-balm-PublicationScheduler-getDefaultSchedule]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/PublicationScheduler.adoc[PublicationScheduler]::getDefaultSchedule
:relfileprefix: ../../../
:mrdocs:

Load into `result` the default scheduled publication interval.

== Synopsis

Declared in `<balm_publicationscheduler.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
getDefaultSchedule(xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval]* result) const;
----

== Description

Load into the specified `result` the default scheduled interval, (set using the `setDefaultSchedule` method), for periodically publishing metrics, if found, and return `true`, or (if not found) return `false` with no effect.

== Return Value

`true` if a default schedule is set, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives the default publication interval
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#