CMCIClientFT.references (3) - Linux Manuals

CMCIClientFT.references: Enumerate association instances for a class instance

NAME

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

SYNOPSIS

#include <cmci.h>

CMPIEnumeration*
CMCIClientFT.references(CMCIClient*cl,


CMPIObjectPath*op,


constchar*resultClass,


constchar*role,


CMPIFlagsflags,


char**properties,


CMPIStatus*rc);

DESCRIPTION

Enumerate association instances that refer to the Instance defined by the op reference.

Arguments are the client object pointer cl, an ObjectPath object pointer op with the reference that contains namespace and classname components, resultClass, 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, role, 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, flags that affect the content of the returned class instance structures, a properties array, and rc which returns the operation status (suppressed when NULL).

The flags argument is a bit mask that can contains the following flags - CMPI_FLAG_IncludeQualifiers and CMPI_FLAG_IncludeClassOrigin.

RETURN VALUE

When successful the CMCIClientFT.references() 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 rc. When unsuccessful it returns a NULL pointer and sets the operation status error code and corresponding error string in rc.

ERRORS

EXAMPLES

CONFORMING TO