Structure::GetStateValue
Defined in:
Translates a state identifier into a state value.
TSOpenDDL.h
Prototype
virtual bool GetStateValue(const String<>& identifier, uint32 *state) const;
Parameters
identifier |
The state identifier specified in the data. |
state |
A pointer to the location to which the corresponding state value is returned. |
Description
The GetStateValue
function is called for the Structure
object representing the enclosing data structure each time a state identifier is encountered in data containing subarrays. An overriding implementation should examine the state specified by the identifier
parameter and store the corresponding state value in the location specified by the state
parameter. If the state identifier is recognized, then the function should return true
. If the state identifier is not recognized, then the function should return false
.