11.9 delete()

Mit dieser Funktion können aus einer Sammlung (Datentypen hash, list, matrix, refvec und vector) einer oder mehrere Werte an einer vorgegebenen Position gelöscht werden. Dahinterliegende Werte werden nach vorne geschoben. Außerdem ist der Datentyp string erlaubt um Zeichen aus einem String zu entfernen.

Das Löschen der Werte erfolgt dabei an der angegebenen Position. Die Positionsangabe muss >= 1 sein, d.h. ein Löschen von Default-Werten an den Indizes [0] bzw. [0,0] ist mit dieser Funktion nicht möglich. Die größtmögliche erlaubte Position entspricht dem aktuellen countof(ListValue).

Die Anzahl der zu löschenden Werte wird über den Count-Parameter angegeben und sollte >= 0 sein.

Im Fehlerfall wird der Funktionsaufruf mit einem fail abgebrochen.

Als fehlerhaft wird auch angesehen, wenn versucht wird mehr Werte bzw. Zeilen oder Spalten zu löschen als überhaupt vorhanden sind.

Definition

anyalue delete
(
      anyvalue ListValue input
      integer  Pos   input
  { , integer  Count := 1 input }
  { , enum     Dir   := dir_row input }
)

Parameter

anyvalue ListValue input
In diesem Parameter wird die Sammlung bzw. der String angegeben aus der Werte gelöscht werden sollen.
integer Pos input
In diesem Parameter wird die Indexposition angegeben, ab der einschließlich das Löschen erfolgen soll. Erlaubt sind Werte >= 1. Bei matrix-Sammlungen stellt Pos je nach Dir-Parameter entweder eine Zeilenposition (dir_row) oder eine Spaltenposition (dir_column) dar.
integer Count := 1 input
In diesem optionalen Parameter wird die Anzahl der Werte (bzw. Zeilen oder Spalten bei einer Matrix) vorgegeben, die zu löschen sind. Erlaubt sind Werte >= 0, wobei bei 0 kein Löschen erfolgt. Durch die Anzahl sollte beim Löschen der mögliche Positionsbereich nicht überschritten werden.
enum Dir := dir_row input
In diesem optionalen Parameter wird die Ausrichtung der Indexposition definiert, was für eine Matrix von Bedeutung ist. Dabei bedeutet der Standardwert dir_row, dass in der Matrix Zeilen gelöscht werden. Bei dir_column werden Spalten gelöscht.

Rückgabewert

Die Funktion gibt die veränderte Sammlung bzw. den veränderten String zurück.

Besonderheiten

Beispiele

Verfügbarkeit

Ab IDM-Version A.06.02.g

Siehe auch

Eingebaute Funktion insert()