CXI-Basis-Programmierreferenz / Version 2 / Datenspeicherung / CxiNode / Typübergreifende Funktionen /

RenameVar - Variable umbenennen

CxiError CxiNode :: RenameVar (CxiName oldname, CxiName newname)
CxiError cxiRenameVar (CxiHandle self, CxiName oldname, CxiName newname)

Benennt eine Variable um

oldname:
Bisheriger Name der Variablen

newname:
Neuer Name der Variablen

return:
0 ok, sonst Fehler

Die Variable mit dem Namen oldname wird nach newname umbenannt. Im Gegensatz zu ExchangeNumber kann diese Funktion beliebige Variablennamen verarbeiten (Name oder Nummer). Folgende Fälle sind möglich und werden unterstützt:

Umbenennung einer Variablen mit Namen in eine Variable mit einem kürzeren oder gleich langen (verschiedenen) Namen. Existiert bereits eine Variable mit dem neuen Namen, so wird sie vor der Umbenennung gelöscht.

Umbenennung einer Variablen mit Namen in eine Variable mit einem längeren Namen. In diesem Fall kann eine Vergrößerung des Blocks notwendig werden, die das CXI-System automatisch durchführt. Existiert bereits eine Variable mit dem neuen Namen, so wird sie vor der Umbenennung gelöscht.

Umbenennung einer Variablen mit Namen in eine Variable mit einem logisch gleichen Namen. Die Namen sind logisch gleich, wenn sie sich gar nicht oder nur in der Groß-/Kleinschreibung unterscheiden. In diesem Fall erfolgt natürlich keine Löschung der Variablen newname vor der Umbenennung. Diese Art der Umbenennung hat keinerlei Einfluss auf den weiteren Zugriff auf den Block, sie dient nur der Lesbarkeit der Variablennamen.

Umbenennung einer Variablen mit Namen in eine Variable mit einer Nummer. Existiert bereits eine Variable mit der neuen Nummer, so wird sie vor der Umbenennung gelöscht.

Umbenennung einer Variablen mit Nummer in eine Variable mit einem Namen. In diesem Fall kann eine Vergrößerung des Blocks notwendig werden, die das CXI-System automatisch durchführt. Existiert bereits eine Variable mit dem neuen Namen, so wird sie vor der Umbenennung gelöscht.

Umbenennung einer Variablen mit Nummer in eine Variable mit einer anderen Nummer. Existiert bereits eine Variable mit der neuen Nummer, so wird sie vor der Umbenennung gelöscht. Sollen die Nummern zweier Variablen vertauscht werden, so kann die Funktion ExchangeNumber benutzt werden.

Umbenennung einer Variablen mit Nummer in eine Variable mit gleicher Nummer. Dieser Sonderfall führt zu keinerlei Aktion, die Funktion kehrt sofort mit cxiNoError zurück.

Portabilität:
Diese Funktion ist in allen unterstützten Systemen verfügbar.

Siehe auch:
ExchangeNumber
DeleteVar
DeleteAllPrefix
ZapNode