Manual Reference Pages  - 3 (2005-06-09)

NAME

CMCICLientFT.enumClasses() - Enumerate classes and subclasss

CONTENTS

Synopsis
Description

SYNOPSIS


#include <cmci.h> 

CMPIEnumeration* CMCIClientFT.enumClasses(CMCIClient*cl,
                                 CMPIObjectPath* op,
                                 CMPIFlags flags,
                                 CMPIStatus* rc);

DESCRIPTION

Enumerate Classies using op as reference. The content of the returned classes 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, and rc the CMPI return status (suppressed when NULL).

The flags argument is a bit mask that can contain the flags CMPI_FLAG_LocalOnly, CMPI_FLAG_DeepInheritance, CMPI_FLAG_IncludeQualifiers, and CMPI_FLAG_IncludeClassOrigin.

RETURN VALUE

When successful the CMCIClientFT.enumClasses() function returns a pointer to a CMPIEnumeration object that contains each enumerated class 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;
CMPIStatus status;

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

objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
enumeration = cc->ft->enumClasses(cc, objectpath, 0, &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), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3), CMPIStatus(3)


SFCBroker Client Library 3 (2005-06-09) sfcc
blog comments powered by Disqus