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.

CMDBDeleteInstance function

The CMDBDeleteInstance function deletes the instance of the class.

Synopsis


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

int CMDBDeleteInstance(
      ARControlStruct
      *control,
      CMDBClassNameId *classNameId,
      ARNameType datasetId,
      ARNameType instanceId,
      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 which the instance to delete belongs. The classNameID argument contains the namespace name and the unique class name.

datasetId

The unique identifier for the dataset. Instances are deleted from a dataset based on the value specified in this parameter.

instanceId

The unique identifier for the instance (system-generated).

deleteOption

A value indicating the action to take when the specified instance cannot be retrieved.

  • 0: Invalid input--This option is currently reserved for future use (CMDB_DELETEOPTION_FIRSTBIT_SET ).
  • 1<<0: Follow weak relationships--Specifies cascade delete for weak relationships. (CMDB_DELETEOPTION_CASCADE_FOLLOW_WEAKREL ).
  • 1<<1: Follow one-to-one and one-to-many relationships--Specifies cascade delete for relationships with one-to-many and one-to-one cardinality. (CMDB_DELETEOPTION_CASCADE_FOLLOW_1TOM_1TO1_REL ).

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