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

NAME

6       CMCIClientFT.associators()  -  Enumerate  instances  associated with an
7       Instance
8

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUE

55       When  successful  the  CMCIClientFT.associators()  function  returns  a
56       pointer to a CMPIEnumeration object that contains the  class  instances
57       found for the class that match the association criteria and sets a suc‐
58       cessful operation status code in rc.  When unsuccessful  it  returns  a
59       NULL pointer and sets the operation status error code and corresponding
60       error string in rc.
61

ERRORS

EXAMPLES
CONFORMING TO
SEE ALSO
66       Common Manageability Programming Interface (CMPI) - OpenGroup,
67       CMCIClient(3),  CMPIEnumeration(3),  CMPIObjectPath(3),   CMPIFlags(3),
68       CMPIStatus(3)
69
70
71
72SFCBroker Client Library             sfcc                        3(2005-06-09)



        

    


            
        

        

            Impressum