GetTextFromCase

Načtení textu z procesu
declare function GetTextFromCase dll "ActualDocument" (string, integer, var boolean, date, string, string, string, pointer): string
sText := GetTextFromCase("actualdocument", 0, bRichText, dDatum, sKey, sOperator, "", actualdocument)
GetTextFromCase(DocKey, Index, HTMLFormat, DateTime, TextKey, Creator, Params, ActDoc)

Parametry

DocKey

Typ: string

ID procesu, ze kterého má být text načten. Pokud je zadáno klíčové slovo actualdocument , bude načítáno z aktuálně otevřeného procesu.

Index

Typ: integer

Index textu v procesu. Indexace začíná 0 a končí hodnotou počet textů - 1. Pro získání počtu textů v procesu použijte funkci GetProcessTextCount . Indexy odpovídají pořadí vložení textů, nejtarší text má index 0 a nejnovější počet textů - 1.

HTMLFormat

Typ: boolean

Parametr udává, zda má funkce vrátit prostý text nebo text v HTML formátu. Současně slouží jako návratová hodnota, v jakém formátu je výsledný text ve skutečnosti - pokud požadujeme HTML formát a text v tomto formátu není k dispozici, vrátí funkce text v prostém formátu a hodnota tohoto parametru je false .

DateTime

Typ: date

V parametru je datum a čas zapsání textu do procesu.

TextKey

Typ: string

Vrací ID textu. Pokud je vrácen prázdný řetězec "" , došlo ve k chybě při čtení textu. Text chyby je možné získat funkcí GetLastErrorMessage . ID je následně možné využít např. ve funkci SetPartActive .

Creator

Typ: string

Vrací jméno uživatele, který text zapsal. Pokud byl text zapsán do procesu v zastupování, je hodnota ve formátu OperatorName (zástupce: DeputyName).

Params

Typ: string

Další parametry. Slouží pro možné budoucí rozšíření funkce. Zatím nepoužíváno.

ActDoc

Typ: pointer

Klíčové slovo actualdocument . Aktuálně otevřený proces. Není-li zadán, vytváří si funkce novou relaci s enTeam (pomalejší). Zároveň pak musí být speficikován parametr DocKey , který bude obsahovat ID procesu pro načtení textu.

Návratová hodnota

Typ: string

Vrací načtený text z procesu.

Popis

Funkce slouží pro načtení textu z procesu, ID tohoto textu, data jeho vytvoření a jména zapisujícího. Text může být vrácen v prostém textu i v HTML formátu.

Ukázky volání

  • sText := GetTextFromCase("actualdocument", 0, bRichText, dDatum, sKey, sOperator, "", actualdocument)