Structure::SetBaseStructureType

Defined in: TSOpenDDL.h

Returns the base structure type.

Prototype

void SetBaseStructureType(StructureType type);

Parameters

type The base structure type.

Description

The GetBaseStructureType function sets the base structure type to that specified by the type parameter. The base structure type represents a more general classification than the type returned by the Structure::GetStructureType function. A subclass of the Structure class may set the base structure type to a custom value in order to indicate that the data structure belongs to a particular category.

Subclasses for custom data structures should specify a unique 32-bit integer for the type parameter, normally represented by a four-character code. All four-character codes consisting only of uppercase letters and decimal digits are reserved for use by the engine.

By default, the base structure type for custom subclasses of the Structure class is the value zero.