cohtml::MapInfo
On this page
Represents a map of a type exposed to the scripting.
#include <Property.h>
Public Attributes
| Name | |
|---|---|
| ElementType | Type Type of the values stored in the map. |
| MapElementGetter | GetElement Callback that returns the value associated with a given key. |
| TypeInfo * | MapTypeInfo Type information for elements when Type is ET_UserType; null otherwise. |
| void * | UserData Pointer to the underlying map. May represent the actual container or an abstraction defined by the property implementation. |
Public Attributes Documentation
variable Type
ElementType Type;
Type of the values stored in the map.
variable GetElement
MapElementGetter GetElement;
Callback that returns the value associated with a given key.
Warning: When Type is a primitive type, except ET_String, GetElement must return a pointer to an actual value of that primitive type. The SDK may cast it directly; for example: (bool*)mapInfo.GetElement(mapInfo.UserData, “enabled”) when Type == ET_Boolean. The returned pointer is not cached by the SDK and must remain valid only for the duration of the call, unless Safe data binding is disabled.
variable MapTypeInfo
TypeInfo * MapTypeInfo;
Type information for elements when Type is ET_UserType; null otherwise.
variable UserData
void * UserData;
Pointer to the underlying map. May represent the actual container or an abstraction defined by the property implementation.