1
.TH 3 2005-06-09 "sfcc" "SFCBroker Client Library"
3
CMCICLientFT.associatorNames() \- Enumerate ObjectPaths associated with an Instance
9
.BI CMCIClientFT.associatorNames (CMCIClient* cl,
11
.BI CMPIObjectPath* op,
13
.BI const char *assocClass,
15
.BI const char *resultClass,
19
.BI const char *resultRole,
26
Enumerate ObjectPath references associated with the Instance defined
27
by \fIop\fP reference.
29
Arguments are the client object pointer \fIcl\fP,
30
an ObjectPath object pointer \fIop\fP with the reference that contains
31
namespace and classname components,
32
\fIassocClass\fP, where if it's not NULL is an association class name that
33
is used to filter the returned set of ObjectPath objects by eliminating
34
objects that aren't associated to the source object by an instance of
35
this class or one of its subclasses,
36
\fIresultClass\fP, where if it's not NULL is a valid class name that
37
is used to filter the returned set of Objects by eliminating objects that
38
aren't an Instance of this Class or one of its subclasses,
39
\fIrole\fP, where if it's not NULL is a valid property name that
40
is used to filter the returned set of ObjectPath objects by eliminating
41
objects that aren't associated to the source object by an association
42
where the source object plays the specified role, i.e. the name of the
43
property in the association class that refers to the source object
44
has to match the value of this parameter,
45
\fIresultRole\fP, where if it's not NULL is a valid property name that
46
is used to filter the returned set of ObjectPath objects by eliminating
47
objects that aren't associated to the source object by an association
48
where the returned object plays the specified role, i.e. the name of
49
the property in the association class that refers to the returned object
50
has to match the value of this parameter,
51
\fIrc\fP which returns the operation status (suppressed when NULL).
53
The \fIflags\fP argument is a bit mask that can contains the following flags -
54
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
56
When successful the \fBCMCIClientFT.associatorNames()\fP function returns
57
a pointer to a CMPIEnumeration object that contains the ObjectPath objects
58
found for the class that match the association criteria and sets a
59
successful operation status code in \fIrc\fR.
60
When unsuccessful it returns a NULL pointer and sets the operation
61
status error code and corresponding error string in \fIrc\fP.
69
Common Manageability Programming Interface (CMPI) - OpenGroup,
71
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)