List of all members.
Public Member Functions
Constructor & Destructor Documentation
Constructs a new array var.
Constructs a VarArray
given a var for which is_array() is true.
This will refer to the same array var, but allow you to access methods specific to arrays.
- Parameters:
-
Constructs a VarArray
given a PP_Var
of type PP_VARTYPE_ARRAY.
- Parameters:
-
[in] | var | A PP_Var of type PP_VARTYPE_ARRAY. |
Member Function Documentation
Gets an element from the array.
- Parameters:
-
[in] | index | An index indicating which element to return. |
- Returns:
- The element at the specified position. If
index
is larger than or equal to the array length, an undefined var is returned.
Gets the array length.
- Returns:
- The array length.
virtual Var& pp::VarArray::operator= |
( |
const Var & |
other | ) |
[virtual] |
The Var
assignment operator is overridden here so that we can check for assigning a non-array var to a VarArray
.
- Parameters:
-
[in] | other | The array var to be assigned. |
- Returns:
- The resulting
VarArray
(as a Var
&).
Reimplemented from pp::Var.
Sets the value of an element in the array.
- Parameters:
-
[in] | index | An index indicating which element to modify. If index is larger than or equal to the array length, the length is updated to be index + 1. Any position in the array that hasn't been set before is set to undefined, i.e., PP_Var of type PP_VARTYPE_UNDEFINED . |
[in] | value | The value to set. |
- Returns:
- A
bool
indicating whether the operation succeeds.
Sets the array length.
- Parameters:
-
[in] | length | The new array length. If length is smaller than its current value, the array is truncated to the new length; any elements that no longer fit are removed. If length is larger than its current value, undefined vars are appended to increase the array to the specified length. |
- Returns:
- A
bool
indicating whether the operation succeeds.
The documentation for this class was generated from the following file: