ArrayIsDirty

Determines if an array is ‘dirty’ (information in the array has changed). When any array element is changed, the ‘Dirty’ flag of the array is set to be TRUE.

Syntax

INT ArrayIsDirty(INT hArray)

hArray:

The handle of the array.

Return Value

1 if true (is dirty), or 0 if false (is not dirty). An error is not returned by this function.

Related Functions

ArrayCopy, ArrayCreate, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetIntByAn, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetString, ArrayGetStringByAn, ArraySetInt, ArraySetIntByAn, ArraySetIsDirty, ArraySetString, ArraySetStringByAn, ArraySwap, DspArrayByAn

Example

hArray = ArrayCreate("TestArray", 3, 3, 3);
error1 = ArraySetIsDirty(hArray, 0); // reset is dirty
intig1 = ArrayIsDirty(hArray); // intig1 = 0 -> reset
ArraySetInt(hArray, 444, 1, 2, 3); // Change a value
intig1 = ArrayIsDirty(hArray) ; // intig1 = 1 -> set

See Also

Array Functions