ReleaseStringList

Funções diversas

Descrição

Libera uma lista de strings retornada anteriormente por outra função da API (por exemplo, CheckFileCompliance). Depois desta chamada, o handle StringListID deixa de ser válido e não deve mais ser passado a GetStringListCount ou GetStringListItem.

Sintaxe

Delphi

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

ActiveX

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

DLL

int DLReleaseStringList(int InstanceID, int StringListID);

Parâmetros

StringListIDO ID da lista de strings a liberar, conforme retornado anteriormente por uma função produtora.

Valores retornados

0StringListID is invalid or does not reference a string list owned by this instance.
1A lista foi liberada com sucesso.

Observações

Listas de strings são de posse da instância PDFlib que as produziu. Elas são liberadas automaticamente quando a instância é destruída, então a liberação explícita normalmente é opcional. Chame ReleaseStringList em processos de longa duração que produzem muitas listas (por exemplo, um worker de CI que valida centenas de PDFs em sequência) para manter o uso de memória limitado.

Exemplo

// Validate many files in a loop, releasing each result list as soon as it has been logged
var
  I, Issues, Count, J: Integer;
begin
  for I := 0 to Files.Count - 1 do
  begin
    Issues := PDF.CheckFileCompliance(Files[I], '', 1, 0);
    if Issues <> 0 then
    begin
      Count := PDF.GetStringListCount(Issues);
      for J := 1 to Count do
        WriteLn(Files[I], ' : ', PDF.GetStringListItem(Issues, J));
      PDF.ReleaseStringList(Issues);
    end;
  end;
end;

Veja também

GetStringListCount, GetStringListItem, CheckFileCompliance