Man Linux: Main Page and Category List

NAME

       CMCIClientFT.getInstance() - Get class instance

SYNOPSIS

       #include <cmci.h>

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

DESCRIPTION

       Get  class  instance using op as reference. The content of the returned
       class instance 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 instance structure content,
        properties  array,  and  rc  which  returns   the   operation   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.getInstance()  function  returns  a
       pointer to a CMPIInstance object and sets a successful status code  for
       rc.   When  unsuccessful  it returns NULL and sets the rc argument with
       the error code and and corresponding error string.

ERRORS

EXAMPLES

CONFORMING TO

SEE ALSO

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