TVariable Label Operators

Assigns or retrieves the label value of a TVariable.

const char16_t* FirstLabel() const;

const char16_t* NextLabel(
   const char16_t *label
) const;

const char16_t* GetLabel() const;

unsigned int SetLabel(
   unsigned int index,
   const char16_t *newLabel
);

unsigned int Erase(
   const char16_t *startLabel,
   const char16_t *finishLabel = NULL
);

Parameters

labelthe label value.
indexthe current index value.
newLabelthe new label value.
startLabelthe label from which to start.
finishLabelthe label that finishes the operation, if set to default, then it will have the same value of startLabel.

Return Values

The methods returning "const char16_t*" will return the string value of the label. SetLabel will return an error code - see Error Codes.

Remarks

Example Use
TVariable var;
var.SetStructure({"one"=>3,"two"=>4,"three"=>5,"four"=>6,
              "five"=>2,"six"=>4,"seven"=>54,"eight"=>5});
const wchar_t *label = var.FirstLabel();
for(; label != NULL; label = var.NextLabel(label))
   MessageBox(
      TVariable("This label = ") 
         + label + ", Has value = "
         + var[i].ToString()
   );

Also See

Index Operators
Comments (0)Listen All
Characters left: 2500
 
Ekky Software Homepage Ekky Software Homepage ObjectDatabase++ TScript Ekky Software Homepage Ekky Software Homepage ObjectDatabase++ TScript