<@DELROWS>

Syntax

<@DELROWS ARRAY=arrayVarName [POSITION=startWhere] [NUM=numToDelete] [SCOPE=scope]>

Description

Deletes rows from the array in the variable named by ARRAY. This tag does not return anything. With no additional attributes specified, this tag deletes one row from the end of the array.

The POSITION attribute specifies the index of the row to start deleting from. If the value specified in POSITION is 0 or greater than the number or rows in the array, no rows are deleted. If POSITION is -1 (the default), the last row in the array is deleted.

The NUM attribute specifies the number of rows to delete. The default is 1. If this attribute specifies a range that, in combination with POSITION, exceeds the bounds of the array, only those rows that do exist in the range are deleted, and no error is returned.

The SCOPE attribute specifies the scope of the variable specified as the value of the ARRAY attribute. If the scope is not specified, the default scoping rules are used.

Meta tags are permitted in any of the attributes.

Examples

• The local variable colors contains the following array:
  

  orange

  amber

  red

  burnt umber

  
  

  <@DELROWS ARRAY="colors" POSITION=2 NUM=2 SCOPE="local">

  The local variable colors now contains the following array:

  
  

  orange

  burnt umber

  
  
  
• The user variable choices_list contains the following array:
  

  News	2
  Sports	3
  Movies	4
  Stocks	1

  
  

  <@DELROWS ARRAY="choices_list" SCOPE="user">

  The user variable choices_list now contains

  News	2
  Sports	3
  Movies	4

See Also

<@ADDROWS>