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

NAME

6       CMCIClientFT.references() - Enumerate association instances for a class
7       instance
8

SYNOPSIS

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

DESCRIPTION

23       Enumerate association instances that refer to the Instance  defined  by
24       the 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,  resultClass,  where if it's not NULL is a valid class name
29       that is used to filter the  returned  set  of  Objects  by  eliminating
30       objects that aren't an Instance of this Class or one of its subclasses,
31       role, where if it's not NULL is a valid property name that is  used  to
32       filter the returned set of instance objects by eliminating objects that
33       aren't associated to the source object  by  an  association  where  the
34       source  object  plays the specified role, i.e. the name of the property
35       in the association class that refers to the source object has to  match
36       the  value  of  this  parameter,  flags  that affect the content of the
37       returned class instance structures, a properties array,  and  rc  which
38       returns the operation status (suppressed when NULL).
39
40       The  flags argument is a bit mask that can contains the following flags
41       - CMPI_FLAG_IncludeQualifiers and CMPI_FLAG_IncludeClassOrigin.
42

RETURN VALUE

44       When  successful  the  CMCIClientFT.references()  function  returns   a
45       pointer to a CMPIEnumeration object that contains the class association
46       instance objects found that match the association criteria, and sets  a
47       successful operation status code in rc.  When unsuccessful it returns a
48       NULL pointer and sets the operation status error code and corresponding
49       error string in rc.
50

ERRORS

EXAMPLES
CONFORMING TO
SEE ALSO
55       Common Manageability Programming Interface (CMPI) - OpenGroup,
56       CMCIClient(3),   CMPIEnumeration(3),  CMPIObjectPath(3),  CMPIFlags(3),
57       CMPIStatus(3)
58
59
60
61SFCBroker Client Library             sfcc                        3(2005-06-09)



        

    


            
        

        

            Impressum