3(2005-06-09)

💖 3 — CMCIClientFT.references() 💖

okay bestie, welcome to section 3 of the manual, dated 2005-06-09 — yes she's an elder but she ATE and she's still serving ✨

---

🌸 NAME 🌸

CMCIClientFT.references() — the way you enumerate association instances for a class instance. that's it, that's the job 💅

---

🦋 SYNOPSIS 🦋

#include <cmci.h>

CMPIEnumeration*
CMCIClientFT.references(CMCIClient*cl,
               CMPIObjectPath*op,
               constchar*resultClass,
               constchar*role,
               CMPIFlagsflags,
               char**properties,
               CMPIStatus*rc);

look at her. seven params. she's iconic and she knows it 👑

---

✨ DESCRIPTION ✨

So basically 💜 she goes and enumerates association instances that refer to the Instance defined by the op reference. like, she's the friend who finds everyone who knows the person you're asking about. no cap.

Here's the full rundown of the arguments, bestie, because we do NOT skip details in this house:

• cl — the client object pointer. your main character, the one doing the calling 🫶
• op — an ObjectPath object pointer carrying the reference that contains namespace and classname components. where the gossip lives.
• resultClass — if it's not NULL, it's a valid class name used to filter the returned set of Objects by eliminating objects that aren't an Instance of this Class or one of its subclasses. so it's a vibe check for the class hierarchy fr fr.
• role — if it's not NULL, it's a valid property name used to filter the returned set of instance objects by eliminating objects that aren't associated to the source object by an association where the source object plays the specified role. okay translating that: the name of the property in the association class that refers to the source object has to match the value of this parameter. i.e. the association has to say "yeah, that's her role" 💅
• flags — flags that affect the content of the returned class instance structures. they change what you actually get back, so pay attention bestie 👀
• properties — a properties array. just a whole array of them.
• rc — returns the operation status, and it's suppressed when NULL. so if you pass NULL she just doesn't tell you how it went. bold of you but okay 😭

---

🎀 the flags argument, specifically 🎀

The flags argument is a bit mask that can contains the following flags:

• CMPI_FLAG_IncludeQualifiers — include those qualifiers, babe ✨
• CMPI_FLAG_IncludeClassOrigin — and include the class origin while you're at it 🌸

that's the whole list. two flags. concise queen.

---

🌈 RETURN VALUE 🌈

When successful 🎉 the CMCIClientFT.references() function returns a pointer to a CMPIEnumeration object that contains the class association instance objects found that match the association criteria, and sets a successful operation status code in rc.

When unsuccessful 💀 it returns a NULL pointer and sets the operation status error code and corresponding error string in rc.

so like... check your rc. always check your rc. it's giving "read the room" but for error handling.

---

🙈 ERRORS 🙈

(nothing listed here — she said no comment, and honestly? respect.)

---

⭐ EXAMPLES ⭐

(also empty. no example. we're all just figuring it out together bestie 🫶)

---

👑 CONFORMING TO 👑

(blank. she conforms to ✨ vibes ✨ and that's on periodt.)

---

🧚 SEE ALSO 🧚

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

go read those too, iykyk 📚💜

---

reminder bestie: keep every one of those flags spelled exactly like that. CMPI_FLAG_IncludeQualifiers. CMPI_FLAG_IncludeClassOrigin. no autocorrect, no lowercase, no "close enough". the compiler does not accept vibes as an argument type 😭

---

and that's the page!! brought to you by the SFCBroker Client Library, sfcc, section 3, dated 2005-06-09. she's been slaying since 2005 and she'll slay forever 💖✨🎀🦋🌸💅🫶👑🌈⭐💀🍓🧚💜