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.

CMDBGraphWalkBegin function

The CMDBGraphWalkBegin function specifies the start node for retrieving CI and relationship instances in a chunk. This function sets up the starting node and query parameters for the graph walk.

Synopsis


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

int CMDBGraphWalkBegin(
      ARControlStruct *control,
      CMDBClassNameId *startClassNameId,
      ARNameType *startInstanceId,
      CMDBGraphWalkQueryStruct *graphWalkQueryStruct,
      CMDBGraphWalkStateStruct *graphWalkStateStruct,
      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.

startClassNameId

The name of the starting node class. The classNameID argument contains the namespace name and the unique class name.

startInstanceId

The instance ID of the starting node for the query.

graphWalkQueryStruct

Specifies information such as the dataset ID of the instances to retrieve, number of levels to walk in the relationship map, the maximum number of rows to retrieve, and the query mode for the query.

Return values



Return value

Description

graphWalkStateStruct

The status of the list of classes walked in the query, next chunks availability, and the next object index. This structure, which is for internal use only, is used as an input argument for the CMDBGraphWalkNext function.

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