SetStrPropertyFromDB

Zápis uživatelské proměnné do databáze 
declare function SetStrPropertyFromDB dll "ActualDocument" (string, string): integer
iRes := SetStrPropertyFromDB("nazev_promenne", "hodnota_promenne")
SetStrPropertyFromDB(Name, Value)

Parametry

Name

Typ: string

Název proměnné. Názvy proměnných jsou citlivé na velikosti písmen (case sensitive).Pokud proměnná se zadaným názvem již existuje, je upravována hodnota existující proměnnné. Pokud proměnná se zadaným názvem neexistuje, je vytvořena nová. Maximální délka názvu proměnné je 50 znaků. Je-li zadán delší řetězec, je oříznut na svou maximální délku.

Value

Typ: string

Hodnota proměnné. Maximální délka hodnoty je 4000 znaků. Je-li zadán delší řetězec, je oříznut na svou maximální délku.

Návratová hodnota

Typ: integer

Výsledek funkce, jež definuje, zda se popis podařilo zapsat, případně kde nastala chyba:
Hodnota Kód chyby Popis
0 (RES_OK) Hodnota byla úspěšně zapsána.
1 (RES_VAL_CROPPED) Popis byl oříznut na svou maximální délku (255 znaků).
2 (RES_NAME_CROPPED) Název vlastnosti byl oříznut na svou maximální délku (50 znaků).
3 (RES_BOTH_CROPPED) Název i hodnota byly oříznuty na své maximální délky.
4 (RES_CONNECT_ERROR) Připojení k databázi se nezdařilo.
5 (RES_INSERT_ERROR) Vložení (INSERT) do databáze se nezdařil.
6 (RES_UPDATE_ERROR) Aktualizace (UPDATE) v databázi se nezdařila.
7 (RES_UNKNOWN_ERROR) Nastala neznámá chyba.

Popis

Hodnotu proměnné lze číst metodou GetStrPropertyFromDB . K proměnné lze nastavit popis pomocí metody SetStrPropertyDescription a tento popis později číst metodou GetStrPropertyDescription . Pro zobrazení přehledu všech proměnných z databáze, jejich hodnot a popisů, lze použít metodu ShowPropertyOverview .

Pokud je některá z těchto funkcí volána vícekrát (nebo více funkcí po jednom výskytu), je vhodné vytvořit si předem připojení do databáze pomocí PropertyFromDBConnect a následně toto připojení ukončit pomocí PropertyFromDBDisconnect - nedochází tak při každém volání k novému připojení k databázi, což zvýší rychlost.

Ukázky volání

  • iRes := SetStrPropertyFromDB("nazev_promenne", "hodnota_promenne")

Příklady použití