dmi_spec_name

Synopsis

#include <opendmi/entity.h>

const char *dmi_spec_name(const dmi_entity_spec_t *spec);

Description

The dmi_spec_name function returns the printable name of the structures a specification decodes, e.g. System information.

The name is translated to the locale set by dmi_set_locale, if the library has a translation for the specification: the translation is the name string of the table named by the code of the specification, e.g. system. Otherwise the name is the name member of the specification.

The specification is named whether the module providing it is enabled in a context or not, since the caller holds the specification itself. The specification a structure has been decoded by is the spec member of the entity, and the specification a type number is mapped to in a context is returned by dmi_type_spec; dmi_type_name names a type number the same way, and also the types no enabled specification is mapped to.

The name belongs to the specification or to the translation, and must not be freed. An untranslated name is static; a translated one is valid until the locale is changed by dmi_set_locale.

Parameters

spec: Specification to name.

Return value

Returns the printable name, or nullptr if spec is nullptr.

Errors

None.