Man Linux: Main Page and Category List

NAME

       CMCIClientFT.getClass() - Get class as reference

SYNOPSIS

       #include <cmci.h>

       CMPIConstClass*
       CMCIClientFT.getClass(CMCIClient*cl,
                      CMPIObjectPath*op,
                      CMPIFlagsflags,
                      char**properties,
                      CMPIStatus*rc);

DESCRIPTION

       Get  Class  using  op  as  reference. The content of the returned class
       structure can be controled using the flags parameter.

       Arguments are the client object pointer cl, ObjectPath  object  pointer
       op  that  contains  namespace and classname components, flags to affect
       the returned class structure content, properties array,  where  if  not
       NULL the members of the array define one or more Property names, and rc
       the CMPI return status (suppressed when NULL).

       The flags argument is a bit mask that can contain combinations  of  the
       following  flags - CMPI_FLAG_LocalOnly, CMPI_FLAG_IncludeQualifiers and
       CMPI_FLAG_IncludeClassOrigin.

       The properties array defines what properties should be returned for the
       class.   If this argument is not NULL, only the class properties in the
       list are returned.  If it’s NULL all class properties are returned.

RETURN VALUE

       When successful the CMCIClientFT.getClass() function returns a  pointer
       to  a  CMPIConstClass  object  and sets a successful status code in rc.
       When unsuccessful it returns NULL and sets the  rc  argument  with  the
       error code and and corresponding error string.

ERRORS

EXAMPLES

          CMCIClient *cc;
          CMPIObjectPath * objectpath;
          CMPIInstance * instance;
          CMPIEnumeration * enumeration;
          CMPIClass *class;
          CMPIStatus status;

          /* Setup a conncetion to the CIMOM */
          cc = cmciConnect("localhost", NULL, NULL, NULL, NULL, NULL);

          objectpath = newCMPIObjectPath("root/cimv2", "Linux_ComputerSystem",
       NULL);
          class = cc->ft->getClass(cc, objectpath, 0, NULL, &status);

          if (!status.rc) {       fprintf(stderr,  "operation  error  code  %d
       description     %s0,                    status.rc,    status.msg->hdl);
            abort();
          }

CONFORMING TO

SEE ALSO

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