Cicode Programming Reference > Cicode Function Categories > Array Functions > ArraySetIsDirty

ArraySetIsDirty

Allows you to indicate that an array is dirty (meaning the information in the array has changed), or not dirty (the information in the array has not been changed).

Syntax

ArraySetIsDirty(INT hArray, INT IsDirty)

hArray:

The handle of the array.

IsDirty:

0= False

1 = True

Return Value

If unsuccessful, an error code will be returned by the IsError Cicode function.

Related Functions

ArrayCreate, ArrayCopy, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetIntByAn, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetString, ArrayGetStringByAn, ArrayIsDirty, ArraySetInt, ArraySetIntByAn, 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

Published June 2018