GetStringListCount

Různé funkce

Popis

Vrací počet řetězců uložených v string listu vytvořeném jinou funkcí API. Nejčastějším producentem je CheckFileCompliance, která vrací nenulové StringListID, jehož položky vypisují problémy shody nalezené ve validovaném dokumentu

Syntaxe

Delphi

Function TPDFlib.GetStringListCount(StringListID: Integer): Integer;

ActiveX

Function PDFlib::GetStringListCount(StringListID As Long) As Long

DLL

int DLGetStringListCount(int InstanceID, int StringListID);

Parametry

StringListID	ID string listu, jak je vrací produkční funkce jako CheckFileCompliance. Musí odkazovat na string list vlastněný aktuální instancí PDFlib

Návratové hodnoty

0	Seznam je prázdný, nebo StringListID neodkazuje na platný string list vlastněný touto instancí
> 0	Počet řetězců aktuálně v seznamu

Poznámky

Vrácený počet je horní mez pro argument ItemIndex funkce GetStringListItem: platné indexy jsou 1 až GetStringListCount(StringListID), včetně. Položky se nečíslují od nuly

Seznamy řetězců vlastní instance PDFlib, která je vytvořila, a automaticky se uvolní při zániku instance. Pokud chcete seznam uvolnit dřív, zavolejte ReleaseStringList — například v dlouho běžícím procesu, který postupně validuje mnoho souborů.

Příklad

// Enumerate every compliance issue reported by CheckFileCompliance
var
  Issues, Count, I: Integer;
begin
  Issues := PDF.CheckFileCompliance('output.pdf', '', 1, 0);
  if Issues <> 0 then
  begin
    Count := PDF.GetStringListCount(Issues);
    for I := 1 to Count do
      WriteLn(PDF.GetStringListItem(Issues, I));
    PDF.ReleaseStringList(Issues);
  end;
end;

Viz také

GetStringListItem, ReleaseStringList, CheckFileCompliance