GetStringListItem

Miscellaneous functions

Description

Retorna a string na posição ItemIndex na lista de strings identificada por StringListID; as listas de strings são produzidas por outras funções de API — mais comumente CheckFileCompliance, que retorna uma entrada por problema de conformidade detectado

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	O ID da lista de strings conforme retornado por uma função produtora, como CheckFileCompliance
ItemIndex	O índice baseado em um do item a ser recuperado; o primeiro item é `1`; o último item é GetStringListCount(StringListID); índices fora do intervalo retornam uma string vazia

Return value

A string no índice solicitado ou uma string vazia se StringListID for inválido ou ItemIndex estiver fora de [1 .. GetStringListCount]

Remarks

Para listas produzidas por CheckFileCompliance, o formato do item é CODE: descrição legível por humanos, onde CODE é um dos códigos de problema de cinco dígitos documentados na página CheckFileCompliance (00002, 00003, 00005, 00006, 00007, 00011, 00012); remova o prefixo antes dos dois-pontos para agir no código programaticamente

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;