GetStringListCount
Funções diversas
Descrição
Retorna o número de strings armazenadas em uma lista de strings criada por outra função da API. A produtora mais comum é CheckFileCompliance, que retorna um StringListID diferente de zero cujas entradas listam as ocorrências de conformidade encontradas no documento validado.
Sintaxe
Delphi
Function TPDFlib.GetStringListCount(StringListID: Integer): Integer;ActiveX
Function PDFlib::GetStringListCount(StringListID As Long) As LongDLL
int DLGetStringListCount(int InstanceID, int StringListID);Parâmetros
| StringListID | O ID da lista de strings conforme retornado por uma função produtora, como CheckFileCompliance. Must reference a string list owned by the current PDFlib instance. |
|---|
Valores retornados
| 0 | A lista está vazia, ou StringListID não referencia uma lista de strings válida de posse desta instância. |
|---|---|
| > 0 | O número de strings atualmente na lista. |
Observações
A contagem retornada é o limite superior do argumento ItemIndex de GetStringListItem: os índices válidos vão de 1 a GetStringListCount(StringListID), inclusive. Os itens não são numerados a partir de zero.
String lists pertencem à instância do PDFlib que as produziu e são liberadas automaticamente quando a instância é destruída. Chame ReleaseStringList se quiser liberar uma lista antes disso — por exemplo, em um processo de longa duração que valida muitos arquivos em sequência.
Exemplo
// 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;