GetStringListCount

Funkcje różne

Opis

Zwraca liczbę ciągów zapisanych na liście ciągów utworzonej przez inną funkcję API. Najczęściej tworzy ją CheckFileCompliance, która zwraca niezerowy StringListID z wpisami wymieniającymi problemy zgodności znalezione w zweryfikowanym dokumencie

Składnia

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	Identyfikator listy ciągów zwrócony przez funkcję tworzącą, taką jak CheckFileCompliance. Musi wskazywać listę ciągów należącą do bieżącej instancji PDFlib

Wartości zwracane

0	Lista jest pusta albo StringListID nie wskazuje prawidłowej listy ciągów należącej do tej instancji
> 0	Liczba ciągów znajdujących się obecnie na liście

Uwagi

Zwrócona liczba jest górną granicą argumentu ItemIndex funkcji GetStringListItem: prawidłowe indeksy obejmują zakres od 1 do GetStringListCount(StringListID) włącznie. Elementy nie są numerowane od zera

Listy ciągów należą do instancji PDFlib, która je utworzyła, i są automatycznie zwalniane podczas niszczenia instancji. Wywołaj ReleaseStringList, aby zwolnić listę wcześniej — na przykład w długotrwałym procesie weryfikującym kolejno wiele plików

Przykład

// 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;

Zobacz również

GetStringListItem, ReleaseStringList, CheckFileCompliance