3(2005-06-09)

💖 CMCIClientFT.getInstance() — the manual, but make it make sense 💖

okay bestie so this is a page from section 3 of the manual, and it's all about one lil function in cmci.h. grab a boba, we're getting into it 🧋✨

---

🎀 NAME 🎀

CMCIClientFT.getInstance() — get a class instance. that's it, that's the whole vibe. iconic. 💅

---

✨ SYNOPSIS ✨

first thing's first, you gotta pull in the header:

#include <cmci.h>

and here's the whole signature, look at her:

CMPIInstance*
CMCIClientFT.getInstance(CMCIClient*cl,
               CMPIObjectPath*op,
               CMPIFlagsflags,
               char**properties,
               CMPIStatus*rc);

yes the args are written all squished like that, that's just how the page is, we're keeping it exactly. 🫶

---

🌸 DESCRIPTION 🌸

so the whole point: you're grabbing a class instance, and you use op as your reference for which one you want. and the tea is — the content of the returned class instance structure can be controlled using the flags parameter. so you have main character energy over what comes back. 👑

let's go through the arguments, one by one, no skipping:

• cl — the client object pointer. your entry point.
• op — an ObjectPath object pointer, and it holds the namespace and classname components. so it literally knows where to look.
• flags — affects the content of the returned class instance structure. more on this below ⬇️
• properties — the properties array. also more on this below ⬇️
• rc — returns the operation status. and important: it gets suppressed when NULL. so if you pass NULL there, no status for you, that's the deal.

🦋 the flags situation 🦋

the flags argument is a bit mask, meaning it can hold combinations of these three:

• CMPI_FLAG_LocalOnly
• CMPI_FLAG_IncludeQualifiers
• CMPI_FLAG_IncludeClassOrigin

combo them however the situation calls for, that's the whole point of a bit mask bestie.

🍓 the properties array 🍓

this one's lowkey important so listen up:

• if properties is not NULL, then only the class properties in that list are returned. narrow it down, be picky, we love a curated selection. ✨
• if it is NULL, then all class properties are returned. the full dump. everything. no filter. 💀

---

🔥 RETURN VALUE 🔥

• when it's successful: the CMCIClientFT.getInstance() function returns a pointer to a CMPIInstance object, and it sets a successful status code for rc. slay. 🎉
• when it's unsuccessful: it returns NULL, and it sets the rc argument with the error code and the corresponding error string. so yeah, rc is your bestie when things go sideways. 😭

---

💜 ERRORS 💜

this section is empty in the original. nothing here. moving on. 🙈

---

🌈 EXAMPLES 🌈

also empty. no examples were provided. tragic, I know. 😭

---

⭐ CONFORMING TO ⭐

empty too. blank. a whole vibe of nothing. 💀

---

🧚 SEE ALSO 🧚

go read these next, fr fr:

• Common Manageability Programming Interface (CMPI) - OpenGroup
• CMCIClient(3)
• CMPIInstance(3)
• CMPIObjectPath(3)
• CMPIFlags(3)
• CMPIStatus(3)

---

ngl the empty sections are just how the page came, I'm not gonna invent content for them. the facts stay the facts, periodt. 💅

---

and that's the page!! this came from the SFCBroker Client Library, source sfcc, dated 2005-06-09, section 3. it's giving vintage but we're still making it cute. bye bestie, go read those SEE ALSO pages 🫶✨🎀