GetStringListItem

Miscellaneous functions

Description

Restituisce la stringa alla posizione ItemIndex nell'elenco di stringhe identificato da StringListID; gli elenchi di stringhe sono prodotti da altre funzioni API — comunemente CheckFileCompliance, che restituisce una voce per ogni problema di conformità rilevato

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	L'ID dell'elenco di stringhe restituito da una funzione produttrice come CheckFileCompliance
ItemIndex	L'indice a base 1 dell'elemento da recuperare; il primo elemento è `1`; l'ultimo elemento è GetStringListCount(StringListID); gli indici fuori intervallo restituiscono una stringa vuota

Return value

La stringa all'indice richiesto, o una stringa vuota se StringListID non è valido o se ItemIndex è al di fuori di [1 .. GetStringListCount]

Remarks

Per gli elenchi prodotti da CheckFileCompliance, il formato dell'elemento è CODE: human-readable description, dove CODE è uno dei codici di problema a cinque cifre documentati nella pagina di CheckFileCompliance (00002, 00003, 00005, 00006, 00007, 00011, 00012); rimuovere il prefisso prima dei due punti per agire sul codice a livello di programma

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;