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.

CMDBGraphWalkQueryStruct structure

The CMDBGraphWalkQueryStruct structure holds the parameters for the query. This structure is used in the CMDBGraphWalkBegin function to set up the starting node in the relationship graph for the query.


typedef struct CMDBGraphWalkQueryStruct
{
   ARNameType datasetId;
   unsigned int datasetMask;
   CMDBGraphWalkRelation walkRelation;
   unsigned int numLevels;
   unsigned int maxRetrieve;
   CMDB_GRAPH_WALK_QUERY_MODE queryMode;
   CMDBGraphWalkSelectorAndFilterList objSelectorAndFilterList;
}CMDBGraphWalkQueryStruct;



The CMDBGraphWalkQueryStruct structure consists of the following elements:

datasetId

The ID of the dataset from which to retrieve the instances.

datasetMask

An integer value that specifies the dataset type for the query.

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

walkRelation



A CMDBGraphWalkRelation structure, which contains the qualification for the query.

numLevels

An integer value indicating the number of levels to walk in the relationship graph. If this parameter is set to a value of 0, the query walks all the levels in the graph.

maxRetrieve

The maximum number of objects to retrieve from the list of objects returned.

queryMode

An integer value that specifies the properties for querying objects in the graph. The match is based on the qualification specified in the CMDBGraphWalkSelectorAndFilterStruct for an object. If no qualification is specified in CMDBGraphWalkSelectorAndFilterStruct, all the objects in the graph are returned.

  • 0 -- Skips those nodes in the graph walk that do not match the qualification that you specified for the query. Use this option to get the connected graph for a given node. The graph walk is stopped and the results are returned when the query finds the first node that does not match the criteria (CMDB_GRAPH_WALK_STOP_IF_NO_MATCH_FOUND ).
  • 1 --The graph walk is stopped and the results are returned when the query finds the first node that matches the qualification. The query returns only the matching nodes and their relationships (CMDB_GRAPH_WALK_STOP_IF_MATCH_FOUND ).
  • 2 --The query walks all levels of the graph to find matching and nonmatching nodes. The query returns only the matching nodes and their relationships (CMDB_GRAPH_WALK_WALK_COMPLETE_GRAPH ).

objSelectorAndFilterList



A objSelectorAndFilterList structure, which contains the selection and filter criteria for the query.

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

Comments