cmciclientft.references(3) [centos man page]

3(2005-06-09)															     3(2005-06-09)

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 compo-
       nents, 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 fil-
       ter 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

SEE ALSO

       Common Manageability Programming Interface (CMPI) - OpenGroup,
       CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3), CMPIStatus(3)

SFCBroker Client Library					       sfcc							     3(2005-06-09)

3(2005-06-09)															     3(2005-06-09)

NAME

       CMPIObjectPath - CMPIObjectPath class implementation

SYNOPSIS

   Public Attributes
       int void * hdl
	   Opaque pointer to class instance data.
       CMPIObjectPathFT * ft
	   Pointer to the Args Function Table.

METHODS

   CMPIStatus(* release )(CMPIObjectPath *op)
       The ObjectPath object will not be used any further and may be freed by CMPI run time system.
   CMPIObjectPath *(* clone )(CMPIObjectPath *op, CMPIStatus *rc)
       Create an independent copy of this ObjectPath object.
   CMPIStatus(* setNameSpace )(CMPIObjectPath *op, const char *ns)
       Set/replace the namespace component.
   CMPIString *(* getNameSpace )(CMPIObjectPath *op, CMPIStatus *rc)
       Get the namespace component.
   CMPIStatus(* setHostname )(CMPIObjectPath *op, const char *hn)
       Set/replace the hostname component.
   CMPIString *(* getHostname )(CMPIObjectPath *op, CMPIStatus *rc)
       Get the hostname component.
   CMPIStatus(* setClassName )(CMPIObjectPath *op, const char *cn)
       Set/replace the classname component.
   CMPIString *(* getClassName )(CMPIObjectPath *op, CMPIStatus *rc)
       Get the classname component.
   CMPIStatus(* addKey )(CMPIObjectPath *op, const char *name, CMPIValue *value, CMPIType type)
       Adds/replaces a named key property.
   CMPIData(* getKey )(CMPIObjectPath *op, const char *name, CMPIStatus *rc)
       Gets a named key property value.
   CMPIData(* getKeyAt )(CMPIObjectPath *op, unsigned int index, CMPIString **name, CMPIStatus *rc)
       Gets a key property value defined by its index.
   unsigned int(* getKeyCount )(CMPIObjectPath *op, CMPIStatus *rc)
       Gets the number of key properties contained in this ObjectPath.
   CMPIStatus(* setNameSpaceFromObjectPath )(CMPIObjectPath *op, CMPIObjectPath *src)
       Set/replace namespace and classname components from <src>.
   CMPIStatus(* setHostAndNameSpaceFromObjectPath )(CMPIObjectPath *op, CMPIObjectPath *src)
       Set/replace hostname, namespace and classname components from <src>.
   CMPIData(* getClassQualifier )(CMPIObjectPath *op, const char *qName, CMPIStatus *rc)
       Get class qualifier value.
   CMPIData(* getPropertyQualifier )(CMPIObjectPath *op, const char *pName, const char *qName, CMPIStatus *rc)
       Get property qualifier value.
   CMPIData(* getMethodQualifier )(CMPIObjectPath *op, const char *methodName, const char *qName, CMPIStatus *rc)
       Get method qualifier value.
   CMPIData(* getParameterQualifier )(CMPIObjectPath *op, const char *mName, const char *pName, const char *qName, CMPIStatus *rc)
       Get method parameter quailifier value.
   CMPIString *(* toString )(CMPIObjectPath *op, CMPIStatus *rc)
       Generates a well formed string representation of this ObjectPath.

DESCRIPTION

       Native CMPIObjectPath implementation.

       This  is the native CMPIObjectPath implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIOb-
       jectPath, however, it works independently from the management broker.

       It is part of a native broker implementation that simulates CMPI data types rather than interacting  with  the  entities  in  a	full-grown
       CIMOM.

Examples
       CMPIString * namespace = objpath->ft->getNameSpace(objectpath, NULL);
       CMPIString * classname = objpath->ft->getClassName(objectpath, NULL);
       int numkeys = objectpath->ft->getKeyCount(objectpath, NULL);

SEE ALSO

       Common Manageability Programming Interface (CMPI) - OpenGroup

SFCBroker Client Library					       sfcc							     3(2005-06-09)