[#BloombergLP-balm-PublicationScheduler-getCategorySchedule-05a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/PublicationScheduler.adoc[PublicationScheduler]::getCategorySchedule
:relfileprefix: ../../../
:mrdocs:

Load the current category publication schedule into `result`.

== Synopsis

Declared in `<balm_publicationscheduler.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
getCategorySchedule(xref:bsl/vector-00d.adoc[bsl::vector<bsl::pair<Category const*, bsls::TimeInterval>>]* result) const;
----

== Description

Load into the specified `result` a representation of the current schedule for publishing categories being followed by this scheduler and return the number of scheduled categories. The schedule is represented using a series of (category address, time interval) pairs; each pair in the series indicates the periodic time interval that the associated category will be published. Note that the `result` of this operation contains only those categories scheduled using the `scheduleCategory` operation, and does _not_ include categories published as part of the default publication.

== Return Value

number of scheduled categories loaded into `result`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives (category, interval) schedule pairs
|===


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