= nng_stat_child(3)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt).  A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//

== NAME

nng_stat_child - get child statistic

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>

typedef struct nng_stat nng_stat;

nng_stat *nng_stat_child(nng_stat *parent);
----

== DESCRIPTION

The `nng_stat_child()` function returns the first child statistic of the
statistic _parent_.
If no children are present, then `NULL` is returned.

TIP: Only statistics with type (see xref:nng_stat_type.3.adoc[`nng_stat_type()`])
of `NNG_STAT_SCOPE` will have children.

== RETURN VALUES

The first child statistic of _parent_, or NULL if _parent_ has no children.

== ERRORS

None.

== SEE ALSO

[.text-left]
xref:libnng.3.adoc[libnng(3)],
xref:nng_stat_next.3.adoc[nng_stat_next(3)],
xref:nng_stats_get.3.adoc[nng_stats_get(3)],
xref:nng_stat.5.adoc[nng_stat(5)],
xref:nng.7.adoc[nng(7)]