blob: bdde3296e0d09df7a1cea06be8ea4902f3593c1d [file] [log] [blame]
.TH 3 2005-06-09 "sfcc" "SFCBroker Client Library"
CMCIClientFT.references() \- Enumerate association instances for a class instance
.B #include <cmci.h>
.BI CMPIEnumeration *
.BI CMCIClientFT.references (CMCIClient* cl,
.BI CMPIObjectPath* op,
.BI const char *resultClass,
.BI const char *role,
.BI CMPIFlags flags,
.BI char** properties,
.BI CMPIStatus* rc);
Enumerate association instances that refer to the Instance defined
by the \fIop\fP reference.
Arguments are the client object pointer \fIcl\fP, an ObjectPath object
pointer \fIop\fP with the reference that contains namespace and classname
\fIresultClass\fP, where if it's not NULL is a valid class name that
is used to filter the returned set of Objects by eliminating objects that
aren't an Instance of this Class or one of its subclasses,
\fIrole\fP, where if it's not NULL is a valid property name that
is 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, i.e. the name of the
property in the association class that refers to the source object
has to match the value of this parameter,
\fIflags\fP that affect the content of the returned class instance structures,
a \fIproperties\fP array, and \fIrc\fP which returns the operation status
(suppressed when NULL).
The \fIflags\fP argument is a bit mask that can contains the following flags -
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
When successful the \fBCMCIClientFT.references()\fP 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 \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation
status error code and corresponding error string in \fIrc\fP.
Common Manageability Programming Interface (CMPI) - OpenGroup,
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),