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.

CMDBGetMultipleInstances function

The CMDBGetMultipleInstances function retrieves multiple instances of the specified class in a dataset.

Synopsis


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

int CMDBGetMultipleInstances(
      ARControlStruct *control,
      CMDBClassNameId *classNameId,
      ARNameType datasetId,
      unsigned int getMask,
      ARNameList *instanceIds,
      ARNameList *attributeGetList,
      ARBooleanList *existList,
      CMDBAttributeValueListList *attributeValueListList,
      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 for which to retrieve the instances. The classNameID argument contains the namespace name and the unique class name.

datasetId

The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in this parameter.

getMask

The ID that specifies the type of dataset on which to perform the operation.

  • 0: None--Based on the datasetId being passed, instances are retrieved from either the overlay or the original dataset (CMDB_GET_MASK_NONE ).
  • 1<<0: Current Mode--Allows you to retrieve instances from the current dataset only (CMDB_GET_DATASET_MODE_CURRENT ).

instanceIds

A list of instance IDs to retrieve.

attributeGetList

A list of attributes to retrieve.

Return values



Return value

Description

existList

A list of flags and corresponding Boolean values indicating whether the attribute list exists. The value TRUE indicates that the attribute list exists; FALSE indicates that the attribute list does not exist.

attributeValueListList

A list of one or more attribute and value pairs retrieved for the specified list of instances.

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