GetStringListCount

Разные функции

Описание

Возвращает число строк в списке строк, созданном другой функцией API. Самый частый производитель — CheckFileCompliance, возвращающий ненулевой StringListID, чьи записи перечисляют проблемы соответствия, найденные в проверенном документе

Синтаксис

Delphi

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

ActiveX

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

DLL

int DLGetStringListCount(int InstanceID, int StringListID);

Параметры

StringListID	ID списка строк, как его вернула функция-производитель, например CheckFileCompliance. Должен ссылаться на список строк, принадлежащий текущему экземпляру PDFlib

Возвращаемые значения

0	Список пуст, либо StringListID не ссылается на корректный список строк, принадлежащий этому экземпляру
> 0	Число строк в списке сейчас

Примечания

Возвращенное число — верхняя граница аргумента ItemIndex в GetStringListItem: допустимые индексы от 1 до GetStringListCount(StringListID) включительно. Элементы нумеруются не с нуля

Списки строк принадлежат экземпляру PDFlib, который их создал, и автоматически освобождаются при уничтожении экземпляра. Если нужно освободить список раньше, вызовите ReleaseStringList — например, в длительном процессе, который по очереди проверяет множество файлов.

Пример

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

См. также

GetStringListItem, ReleaseStringList, CheckFileCompliance