[#BloombergLP-balm-PublicationScheduler-cancelCategorySchedule-0f]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/PublicationScheduler.adoc[PublicationScheduler]::cancelCategorySchedule
:relfileprefix: ../../../
:mrdocs:

Cancel the periodic publication schedule for `category`.

== Synopsis

Declared in `<balm_publicationscheduler.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
cancelCategorySchedule(xref:BloombergLP/balm/Category.adoc[Category] const* category);
----

== Description

Cancel the periodic publication of the specified `category`. Return 0 on success, and a non‐zero value if the `category` is not scheduled for publication. Any scheduled publication of `category` is either canceled or completed before this method returns. The behavior is undefined unless `category` is a valid address supplied by the `balm::MetricRegistry` owned by `metricsManager`. Note that if a default publication schedule has been set (using `setDefaultSchedule`), then `category` will continue to be published as part of that scheduled default publication; to exclude a category from any publication, clients can disable the category using the `MetricsManager` object supplied at construction.

== Return Value

0 on success, or a non‐zero value if `category` is not scheduled

== Parameters

[cols="1,4"]
|===
| Name| Description
| *category*
| category to unschedule from periodic publication
|===


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