[#BloombergLP-balm-ConfigurationUtil-setPreferredPublicationType]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/ConfigurationUtil.adoc[ConfigurationUtil]::setPreferredPublicationType
:relfileprefix: ../../../
:mrdocs:

Set the preferred publication type for a metric&period;

== Synopsis

Declared in `&lt;balm&lowbar;configurationutil&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
setPreferredPublicationType(
    char const* category,
    char const* metricName,
    xref:BloombergLP/balm/PublicationType/Value.adoc[PublicationType::Value] publicationType,
    xref:BloombergLP/balm/MetricsManager.adoc[MetricsManager]* manager = 0);
----

== Description

Set the preferred publication type of the metric identified by the specified `category` and `metricName` to the specified `publicationType`&period; Optionally specify a metrics `manager` to configure&period; If `manager` is 0, configure the default metrics manager&semi; if `manager` is 0 and the default metrics manager has not been initialized, this method has no effect&period; Return 0 on success, or a non&hyphen;zero value if `manager` is 0 and the default metrics manager has not been initialized&period; The preferred publication type of a metric indicates the preferred aggregate to publish for that metric, or `PublicationType&colon;&colon;e&lowbar;UNSPECIFIED` if there is no preference&period; For example, specifying `e&lowbar;AVG` indicates that the average value of the collected metric should be reported&period; If a `MetricId` does not exist for `category` and `metricName`, create one and add it to the metric registry of the indicated metrics manager&period; Note that there is no uniform definition for how publishers will interpret this value&period;

== Return Value

0 on success, or a non&hyphen;zero value if `manager` is 0 and the default metrics manager has not been initialized

== Parameters

[cols="1,4"]
|===
| Name| Description
| *category*
| category of the metric to configure
| *metricName*
| name of the metric to configure
| *publicationType*
| preferred publication aggregate
| *manager*
| metrics manager to configure&semi; 0 uses the default
|===


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