13(2005-06-09)                                                    3(2005-06-09)
2
3
4

NAME

6       CMCICLientFT.associatorNames()  - Enumerate ObjectPaths associated with
7       an Instance
8

SYNOPSIS

10       #include <cmci.h>
11
12       CMPIEnumeration*
13       CMCIClientFT.associatorNames(CMCIClient*cl,
14                      CMPIObjectPath*op,
15                      constchar*assocClass,
16                      constchar*resultClass,
17                      constchar*role,
18                      constchar*resultRole,
19                      CMPIStatus*rc);
20
21

DESCRIPTION

23       Enumerate ObjectPath references associated with the Instance defined by
24       op reference.
25
26       Arguments  are  the  client  object  pointer  cl,  an ObjectPath object
27       pointer op with the reference that  contains  namespace  and  classname
28       components,  assocClass, where if it's not NULL is an association class
29       name that is used to filter the returned set of ObjectPath  objects  by
30       eliminating  objects  that aren't associated to the source object by an
31       instance of this class or one of its subclasses, resultClass, where  if
32       it's not NULL is a valid class name that is used to filter the returned
33       set of Objects by eliminating objects that aren't an Instance  of  this
34       Class or one of its subclasses, role, where if it's not NULL is a valid
35       property name that is used to filter the  returned  set  of  ObjectPath
36       objects  by  eliminating  objects  that aren't associated to the source
37       object by an association where the source object  plays  the  specified
38       role,  i.e.  the  name  of  the  property in the association class that
39       refers to the source object has to match the value of  this  parameter,
40       resultRole,  where  if  it's  not NULL is a valid property name that is
41       used to filter the returned set of ObjectPath  objects  by  eliminating
42       objects  that  aren't associated to the source object by an association
43       where the returned object plays the specified role, i.e.  the  name  of
44       the  property  in  the  association  class  that refers to the returned
45       object has to match the value of this parameter, rc which  returns  the
46       operation status (suppressed when NULL).
47
48       The  flags argument is a bit mask that can contains the following flags
49       - CMPI_FLAG_IncludeQualifiers and CMPI_FLAG_IncludeClassOrigin.
50

RETURN VALUE

52       When successful the CMCIClientFT.associatorNames() function  returns  a
53       pointer  to  a  CMPIEnumeration  object  that  contains  the ObjectPath
54       objects found for the class that match  the  association  criteria  and
55       sets  a  successful  operation status code in rc.  When unsuccessful it
56       returns a NULL pointer and sets the operation  status  error  code  and
57       corresponding error string in rc.
58

ERRORS

EXAMPLES

CONFORMING TO

SEE ALSO

63       Common Manageability Programming Interface (CMPI) - OpenGroup,
64       CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)
65
66
67
68SFCBroker Client Library             sfcc                        3(2005-06-09)
Impressum