smi_render(3)

smi_render(3) 💖 SMI Management Information Library 🫶

🎀 NAME 🎀

smiRenderOID, smiRenderValue, smiRenderNode, smiRenderType — the SMI data and MIB data rendering routines. They’re your little string-making besties for OIDs, MIB values, node names, and type names. 💅

✨ SYNOPSIS ✨

#include <smi.h>

char *smiRenderOID(unsigned int oidlen, SmiSubid *oid, int flags);

char *smiRenderValue(SmiValue *smiValuePtr, SmiType *smiTypePtr, int flags);

char *smiRenderNode(SmiNode *smiNodePtr, int flags);

char *smiRenderType(SmiType *smiTypePtr, int flags);

🦋 DESCRIPTION 🦋

okay so these functions can be used to render OIDs, values of MIB data, or names of MIB nodes or types. That’s the whole main-character job: take the SMI thing, hand back a rendered thing. ✨

• smiRenderOID() — renders an OID given by its length oidlen and its array of sub-identifiers oid*. The flags can be used to control the resulting format; see FORMATS below. 🦋
• smiRenderValue() — renders a MIB data value given by smiValuePtr. An underlying type smiTypePtr may be supplied to support a more human friendly rendering. The flags can be used to control the resulting format; see FORMATS below. 🍓
• smiRenderNode() — renders the name of a node given by smiNodePtr. The flags can be used to control the resulting format; see FORMATS below. 🌸
• smiRenderType() — renders the name of a type given by smiTypePtr. The flags can be used to control the resulting format; see FORMATS below. 💜

🌈 FORMATS 🌈

Each of these functions gets a last argument named flags. This is a logically or-ed set of flags that can be used to control the format of the rendered items:

• SMI_RENDER_NUMERIC — allow numeric representation (default). 🔢
• SMI_RENDER_NAME — allow a representation by name(s) if possible. 🏷️
• SMI_RENDER_QUALIFIED — in case of a name representation, force a module prefix, e.g. IF-MIB::ifIndex instead of just ifIndex. 👑
• SMI_RENDER_FORMAT — in case of smiRenderValue(), force the application of a format specification (e.g. an SMIv2 DISPLAY-HINT) of an underlying type if the smiTypePtr argument is not NULL and this type contains such a format specification. 🎀
• SMI_RENDER_PRINTABLE — in case of octet string value rendering, force a printable representation if all octets of the octet string are printable. 🔤
• SMI_RENDER_UNKNOWN — force the return of a string containing SMI_LABEL_UNKNOWN ("<unknown>"), if the rendering would fail. This way, the only condition where NULL can be returned is the lack of memory. 💀
• SMI_RENDER_ALL — apply a combination of all these flags. This supports the (hopefully) most human friendly representations. 🌈

💖 RETURN VALUE 💖

All of these functions return a string, if successful, or NULL in case of a rendering failure. See also the SMI_RENDER_UNKNOWN flag above. 🫶

👀 SEE ALSO 👀

libsmi(3), smi.h — go peek, bestie. 👑

🌟 AUTHOR 🌟

(C) 2002 Frank Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>

---

footer credits, bestie: source/version IBR · date July 24, 2002 · page smi_render(3). that’s the whole page — periodt. 💖🎀