NAME

       hwlocality_info_attr - Consulting and Adding Info Attributes

SYNOPSIS

   Functions
       static const char * hwloc_obj_get_info_by_name (hwloc_obj_t obj, const char *name)
       int hwloc_obj_add_info (hwloc_obj_t obj, const char *name, const char *value)

Detailed Description

Function Documentation

   int hwloc_obj_add_info (hwloc_obj_t obj, const char * name, const char * value)
       Add the given name and value pair to the given object info attributes. The info pair is
       appended to the existing info array even if another pair with the same name already
       exists.

       The input strings are copied before being added in the object infos.

       Returns
           0 on success, -1 on error.

       Note
           This function may be used to enforce object colors in the lstopo graphical output by
           adding 'lstopoStyle' as a name and 'Background=#rrggbb' as a value. See CUSTOM COLORS
           in the lstopo(1) manpage for details.

           If name or value contain some non-printable characters, they will be dropped when
           exporting to XML, see hwloc_topology_export_xml() in hwloc/export.h.

   static const char * hwloc_obj_get_info_by_name (hwloc_obj_t obj, const char * name) [inline],
       [static]
       Search the given name in object infos and return the corresponding value. If multiple info
       attributes match the given name, only the first one is returned.

       Returns
           A pointer to the value string if it exists.

           NULL if no such info attribute exists.

       Note
           The string should not be freed by the caller, it belongs to the hwloc library.

Author

       Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code.