CentOS 7.0 - man page for cmciclientft.associators (centos section 3)

Linux & Unix Commands - Search Man Pages

Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


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

NAME
       CMCIClientFT.associators() - Enumerate instances associated with an Instance

SYNOPSIS
       #include <cmci.h>

       CMPIEnumeration*
       CMCIClientFT.associators(CMCIClient*cl,
		      CMPIObjectPath*op,
		      constchar*assocClass,
		      constchar*resultClass,
		      constchar*role,
		      constchar*resultRole,
		      CMPIFlagsflags,
		      char**properties,
		      CMPIStatus*rc);

DESCRIPTION
       Enumerate instances associated with the Instance defined by op reference.

       Arguments  are the client object pointer cl, an ObjectPath object pointer op with the ref-
       erence that contains namespace and classname components, assocClass,  where  if	it's  not
       NULL  is  an  association  class  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  instance
       of  this  class	or  one of its subclasses, 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 elim-
       inating	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, result-
       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 returned object plays the specified role, i.e. the name of the
       property  in  the  association  class  that refers to the returned 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_Includ-
       eQualifiers and CMPI_FLAG_IncludeClassOrigin.

RETURN VALUE
       When successful the CMCIClientFT.associators() function returns a pointer to a CMPIEnumer-
       ation object that contains the class instances found for the class that match the associa-
       tion  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)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 10:13 PM.

Unix & Linux Forums Content Copyright©1993-2018. All Rights Reserved.
×
UNIX.COM Login
Username:
Password:  
Show Password





Not a Forum Member?
Forgot Password?