- 2.3 NDB API Classes, Interfaces, and Structures
- 2.3.1 The Column Class
- 2.3.2 The Datafile Class
- 2.3.3 The Dictionary Class
- 2.3.4 The Event Class
- 2.3.5 The Index Class
- 2.3.6 The LogfileGroup Class
- 2.3.7 The List Class
- 2.3.8 The Ndb Class
- 2.3.9 The NdbBlob Class
- 2.3.10 The NdbDictionary Class
- 2.3.11 The NdbEventOperation Class
- 2.3.12 The NdbIndexOperation Class
- 2.3.13 The NdbIndexScanOperation Class
- 2.3.14 The NdbInterpretedCode Class
- 2.3.15 The NdbOperation Class
- 2.3.16 The NdbRecAttr Class
- 2.3.17 The NdbScanFilter Class
- 2.3.18 The NdbScanOperation Class
- 2.3.19 The NdbTransaction Class
- 2.3.20 The Object Class
- 2.3.21 The Table Class
- 2.3.22 The Tablespace Class
- 2.3.23 The Undofile Class
- 2.3.24 The Ndb_cluster_connection Class
- 2.3.25 The NdbRecord Interface
- 2.3.26 The AutoGrowSpecification Structure
- 2.3.27 The Element Structure
- 2.3.28 The GetValueSpec Structure
- 2.3.29 The IndexBound Structure
- 2.3.30 The Key_part_ptr Structure
- 2.3.31 The NdbError Structure
- 2.3.32 The OperationOptions Structure
- 2.3.33 The PartitionSpec Structure
- 2.3.34 The RecordSpecification Structure
- 2.3.35 The ScanOptions Structure
- 2.3.36 The SetValueSpec Structure
Abstract
This section covers the List class.
Parent class. Dictionary
Child classes. None
Description.
The List class is a
Dictionary subclass that is used for
representing lists populated by the methods
Dictionary::listObjects(),
Dictionary::listIndexes(), and
Dictionary::listEvents(). (See
Section 2.3.3.1.26, “Dictionary::listObjects()”,
Section 2.3.3.1.27, “Dictionary::listIndexes()”, and
Section 2.3.3.1.28, “Dictionary::listEvents()”, for more information
about these methods.)
Class Methods. This class has only two methods, a constructor and a destructor. Neither method takes any arguments.
Constructor.
Calling the List constructor creates a new
List whose count and
elements attributes are both set equal to
0.
Destructor.
The destructor ~List() is simply defined in
such a way as to remove all elements and their properties. You can
find its definition in the file
/storage/ndb/include/ndbapi/NdbDictionary.hpp.
Attributes.
A List has two attributes:
count, an unsigned integer, which stores the number of elements in the list.elements, a pointer to an array ofElementdata structures contained in the list. See Section 2.3.27, “TheElementStructure”.
Types.
The List class defines an
Element structure, which is described in the
following section.
Note
For a graphical representation of this class and its parent-child
relationships, see Section 2.3.3, “The Dictionary Class”.
