bool SetVariableArray(SetArrayType type, const char* ppathToVar, unsigned index, const void* pdata, unsigned count, SetVarType setType = SV_Sticky); bool SetVariableArray(const char* ppathToVar, unsigned index, const Value* pdata, unsigned count, SetVarType setType = SV_Sticky);
SetVariableArray sets array elements in specified range to data items of specified type. If array does not exist, it is created. If an array already exists but does not contain enough items, it is resized appropriately. Under some conditions index > 0 can cause new elements to be inserted into the array. These elements are initialized to 0 for numeric types, empty string "" for strings, and 'undefined' for values. SetVariableArray can fail if there is not enough memory or if the path is invalid.
|
Parameters |
Description |
|
SetArrayType type |
The type of array being set (SA_Int, SA_Double, SA_Float, SA_String, SA_StringW or SA_Value). |
|
const char* ppathToVar |
A name or path to the variable whose value is being requested. |
|
unsigned index |
The index in the array to start setting the data to. |
|
const void* pdata |
A pointer to the beginning of the data. |
|
unsigned count |
The number of items to set. |
|
SetVarType setType = SV_Sticky |
Describes the delayed assignment queuing behavior (SV_Normal, SV_Sticky, or SV_Permanent). |
A Boolean value of 1 if successful, otherwise 0.