Book a Demo
Prev Next

Interface CMDataNode

The CMDataNode objects contain detailed information relating to each item matching the executed mFQL query.

Each CMDataNode contains the name of the matching source code element, along with the line number and column number within the source code file where the matching element was found. Each CMDataNode also contains its own array of CMDataNode objects as well as an array of CMFacet objects. The CMFacet objects are detailed in a separate topic.

CMDataNode Methods

Method

Remarks

See also

GetName()

Returns the name of the CMDataNode

Return type:  string  (read only)

GetLine()

Returns the line on which this node can be found.

Return type:  long  (read only)

GetColumn()

Returns the column on which this node can be found.

Return type:  long  (read only)

GetChildCount()

Returns the number of CMDataNode child nodes belonging to the current CMDataNode.

Return type:  long  (read only)

GetChildNode(long index)

Returns the CMDataNode object found at the nth position in the array of CMDataNode child nodes, or NULL if not found.

Return type:  CMDataNode  (read only)

Parameters:

  • index:  specifies the array position of the child node to be retrieved.  (0 based index)

GetFacetCount()

Returns the number of CMFacet objects that are part of the current node.

Return type:  long  (read only)

GetFacet(long index)

Returns the CMFacet object found at the nth position in the array of CMFacet child nodes, or NULL if not found.

Return type:  CMFacet  (read only)

Parameters:

  • index:  specifies the array position of the facet node to be retrieved.  (0 based index)
Interface CMFacet

GetFacetByName(string name)

Returns the named CMFacet object, or NULL if not found.

Return type:  CMFacet  (read only)

Parameters:

  • name:  specifies the name of facet to find.
Interface CMFacet

LearnMore