[#BloombergLP-balb-PerformanceMonitor-registerPid]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::xref:BloombergLP/balb/PerformanceMonitor.adoc[PerformanceMonitor]::registerPid
:relfileprefix: ../../../
:mrdocs:

Register a process with this performance monitor.

== Synopsis

Declared in `<balb_performancemonitor.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
registerPid(
    int pid,
    xref:bsl/string.adoc[bsl::string] const& description);
----

== Description

Register the specified process `pid` having the specified user‐defined `description` with this performance monitor. After registration, performance statistics will be collected for the `pid` upon invocation of the `collect` function. A `pid` value of zero is translated to the current process id. Return 0 on success or a non‐zero value otherwise.

== Return Value

0 on success, or a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *pid*
| process id to register; 0 means the current process
| *description*
| user‐defined description for the process
|===


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