StringListAddObject

Přidá novou položku do seznamu řetězců
declare function StringListAddObject dll "ActualDocument" (integer, string, integer): integer
Index := StringListAddObject(SList, "PoložkaN", Obj)
StringListAddObject(StringList, Item, Object)

Parametry

StringList

Typ: integer

Identifikátor seznamu řetězců získaný funkcí StringListCreate .

Item

Typ: string

Nová položka, která bude vložena.

Object

Typ: integer

Objekt, který je na položku navázaný. Může jím být např. jiný seznam řetězců. Lze jej také využít pro uložení celého čísla, které není objektem. V tomto případě není nutné objekt před uvolněním celého seznamu řetězců uvolňovat.

Návratová hodnota

Typ: integer

Vrací index právě vložené položky. Dojde-li k chybě, je vrácena -1 . Pro získání popisu chyby použijte funkci GetLastErrorMessage .

Popis

Funkce vloží do existujícího seznamu řetězců novou položku a s ní související objekt. Položka je vkládána na konec existujícího seznamu v případě neseřazeného seznamu řetězců nebo na pozici dle hodnoty položky, je-li seznam řetězců seřazený. Řazení je možné ovlivnit pomocí funkce StringListSetSorted . Seznamu řetězců musí být předem vytvořen funkcí StringListCreate .

Ukázky volání

  • Vložení nové položky na konec seznamu.
    Index := StringListAddObject(SList, "PoložkaN", Obj)