This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

CMDBGetListClass function

The CMDBGetListClass function retrieves a list of classes. You can specify one or more of the classNameIdRelation, superclassName, and characQueryList qualification parameters.

Synopsis


#include "ar.h"
#include "arextern.h"
#include "cmdb.h"

int CMDBGetListClass(
      ARControlStruct *control,
      ARNameType namespaceName,
      CMDBClassNameId *classNameIdRelation,
      CMDBClassNameId *superclassName,
      ARPropList *characQueryList,
      ARBoolean getHiddenClasses,
      CMDBClassNameIdList *classNameIdList,
      ARStatusList *status)

Input arguments



Input argument

Description

control

The control record for the operation, which contains information about the user requesting the operation and the server on which the operation is to be performed.

namespaceName

The name of the namespace. Namespaces are a way of partitioning your data model to create logical groups of classes. The Class Manager namespaces are implemented using a prefix-based naming convention on classes.

classNameIdRelation

Retrieves the relationship classes that have a class specified in this parameter as part of the relationship.

superclassName

The superclass name of the classes to retrieve.

characQueryList

The search criteria.

getHiddenClasses

A Boolean flag that indicates whether to retrieve the hidden classes.

Return values



Return value

Description

classNameIdList

A list of class names that match the specified criteria.

status

A list of zero or more notes, warnings, or errors generated from a call of this function.

Was this page helpful? Yes No Submitting... Thank you

Comments