GetVariableStr

Načte hodnotu proměnné typu string 
declare function GetVariableStr dll "ActualDocument" (string, string, pointer, var boolean): string
Name := GetVariableStr("MTB_00000Nt", "Name", actualdocument, Loaded)
GetVariableStr(DocKey, Name, ActDoc, Loaded)

Parametry

DocKey

Typ: string

Obsahuje id procesu. Pro aktuální proces je možné zadat prázdný řetezec nebo klíčové slovo actualdocument .

Name

Typ: string

Název proměnné.

ActDoc

Typ: pointer

Klíčové slovo actualdocument odkazující na aktuální proces. Je-li zadáno nil , vytváří se nové připojení k enTeam (pomalejší).

Loaded

Typ: boolean

Výstupní proměnná obsahující informaci, zda se povedlo hodnotu proměnné načíst - pokud ano, obsahuje true , jinak obsahuje false .

Návratová hodnota

Typ: string

Vrací hodnotu proměnné. Pokud se nepovedlo hodnotu proměnné načíst (viz parametr Loaded ), obsahuje "" .

Popis

Načte hodnotu proměnné typu string ze zadaného procesu. Tuto funkci je možné použít pro libovolný typ proměnné, ale doporučujeme pro ostatní typy použít příslušnou alternativu. Pokud se nepodaří hodnotu proměnné načíst, je možné vyzvednout chybu pomocí funkce GetLastErrorMessage .

Ukázky volání

  • Name := GetVariableStr("MTB_00000Nt", "Name", actualdocument, Loaded)