Book a Demo
Prev Next

Interface CMDataSet

The CMDataSet is used to return the results of executing an mFQL query against a Code Miner library.

The results are returned as binary data in a CMDataSet, which consists of an array of CMDataNode objects. The CMDataNode objects, details of which can be found in a separate topic, contain detailed information of a 'match' for the search query.  Information related to each CMDataSet node, such as the name of the source code file, the line number and also the start and end position within the source code file, where the match occurred, can be obtained through the CMDataSet functions set out below.

All data within the CMDataSet is read-only.

CMDataSet Attributes

Attributes

Remarks

Count

The number of items in the dataset.

Type:  long  (read only)

CMDataSet Methods

Method

Remarks

See also

GetFilename(long index)

Returns the name of the source code file in which the matching element was found.

Return type:  string  (read only)

Parameters:

  • index:  specifies the array position of the child node for which the Filename is being retrieved. (0 based index.)

GetPosition(long index)

Returns the position within the source code file, at which the matching element was found.  The returned value has the format: "<startPosition>:<endPosition>"

Return type:  string  (read only)

Parameters:

  • index:  specifies the array position of the child node for which the position information is being retrieved.   (0 based index.)

GetAddress(long index)

A Code Miner database, consists of a list of abstract syntax tree nodes, where the primary key of each node is its address.  This function operates on a list of AST nodes and returns the primary key (address) of the nth entry in that list.

Return type:  string  (read only)

Parameters:

  • index: specifies the array position of the child node for which the address information is being retrieved.   (0 based index.)

GetPositionStart(long index)

Returns the start position within the source code file, at which the matching element was found.

Return type:  long  (read only)

Parameters:

  • index:  specifies the array position of the child node for which the start position information is being retrieved.  (0 based index.)

GetPositionEnd(long index)

Returns the end position within the source code file, at which the matching element was found.

Return type:  long  (read only)

Parameters:

  • index:  specifies the array position of the child node for which the end position information is being retrieved.  (0 based index.)

GetChildCount()

Returns count of number of CMDataNode child nodes in this CMDataSet.

Return type:  long  (read only)

GetChildNode(long index)

Returns the CMDataNode object at the specified index position.

Return type:  CMDataNode  (read only)

Parameters:

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

LearnMore

Prev Next