GetStringListItem

Miscellaneous functions

Description

Returns the string at position ItemIndex in the string list identified by StringListID. String lists are produced by other API functions — most commonly CheckFileCompliance, which returns one entry per detected compliance issue.

Syntax

Delphi

Function TPDFlib.GetStringListItem(StringListID, ItemIndex: Integer): WideString;

ActiveX

Function PDFlib::GetStringListItem(StringListID As Long, ItemIndex As Long) As String

DLL

const wchar_t * DLGetStringListItem(int InstanceID, int StringListID, int ItemIndex);

Parameters

StringListID	Идентификатор списка строк, возвращенный функцией-продюсером, такой как CheckFileCompliance
ItemIndex	Индекс извлекаемого элемента, начиная с единицы; первый элемент — `1`, последний — GetStringListCount(StringListID); индексы вне диапазона возвращают пустую строку

Return value

Строка по запрошенному индексу или пустая строка, если дескриптор StringListID недействителен или ItemIndex находится вне диапазона [1 .. GetStringListCount]

Remarks

Для списков, создаваемых CheckFileCompliance, формат элемента имеет вид CODE: понятное человеку описание, где CODE — один из пятизначных кодов проблем, документированных на странице CheckFileCompliance (00002, 00003, 00005, 00006, 00007, 00011, 00012); удалите префикс перед двоеточием для программной обработки кода

Example

// Parse the issue code from each compliance issue line
var
  Issues, Count, I, ColonPos: Integer;
  Line, Code: WideString;
begin
  Issues := PDF.CheckFileCompliance('archive.pdf', '', 1, 0);
  if Issues = 0 then Exit;

  Count := PDF.GetStringListCount(Issues);
  for I := 1 to Count do
  begin
    Line := PDF.GetStringListItem(Issues, I);
    ColonPos := Pos(':', Line);
    if ColonPos > 0 then
      Code := Trim(Copy(Line, 1, ColonPos - 1))
    else
      Code := Line;

    if Code = '00006' then
      WriteLn('Document is encrypted — cannot be PDF/A')
    else
      WriteLn('Issue ', Code, ': ', Line);
  end;
  PDF.ReleaseStringList(Issues);
end;