Dokumentace enTeam
SetStrPropertyDescription
declare function SetStrPropertyDescription dll "ActualDocument" (string, string): integer SetStrPropertyDescription("nazev_promenne", "Proměnná slouží k demonstračním účelům.")
SetStrPropertyDescription(Name, Description)
Parametry
- Name
-
Typ: string
Název proměnné. 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.
- Description
-
Typ: string
Popis proměnné. Maximální délka popisu proměnné je 255 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
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ž má za následek zvýšení rychlosti.
Ukázky volání
-
SetStrPropertyDescription("nazev_promenne", "Proměnná slouží k demonstračním účelům.")