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.

CMDBDeleteClass function

The CMDBDeleteClass function deletes a specified class and its associated attributes.

Synopsis


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

int CMDBDeleteClass(
      ARControlStruct
      *control,
      CMDBClassNameId *classNameId,
      unsigned int deleteOption,
      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.

classNameID

The name of the class to delete. The classNameID argument contains the namespace name and the unique class name.

deleteOption

A value indicating the action to take if the specified class contains attributes or subclasses.

  • 0: None--Delete the class only if the class contains no instances and has no subclasses or dependent relationships ( CMDB_DELETE_CLASS_OPTION_NONE ).
  • 1: With data--Delete the class only if the class has no subclasses or dependent relationships. This applies only to regular classes (CMDB_DELETE_CLASS_OPTION_WITH_DATA ).
  • 2: All dependencies--Delete the class, including all the subclasses, dependent relationship classes, and audit history (if any) that are associated with the class. All the dependencies for the specified class are deleted (CMDB_DELETE_CLASS_OPTION_ALL_DEPENDENCIES ). This option overrides the CMDB_CLASS_DATA_DELETE option.

Note: To retain the audit history after you delete the class, back up the class audit form before you delete the class. |

Return value



Return value

Description

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