GetStringListCount
Funções diversas
Descrição
Devolve o número de cadeias armazenadas numa lista de cadeias criada por outra função da API. O produtor mais comum é CheckFileCompliance, que devolve um StringListID diferente de zero cujas entradas enumeram os problemas de conformidade encontrados no documento validado
Sintaxe
Delphi
Function TPDFlib.GetStringListCount(StringListID: Integer): Integer;
ActiveX
Function PDFlib::GetStringListCount(StringListID As Long) As Long
DLL
int DLGetStringListCount(int InstanceID, int StringListID);
Parâmetros
| StringListID | O ID da lista de cadeias devolvido por uma função produtora como CheckFileCompliance. Deve referenciar uma lista de cadeias pertencente à instância PDFlib atual |
|---|
Valores devolvidos
| 0 | A lista está vazia ou StringListID não referencia uma lista de cadeias válida pertencente a esta instância |
|---|---|
| > 0 | O número de cadeias atualmente presentes na lista |
Observações
O número devolvido é o limite superior do argumento ItemIndex de GetStringListItem: os índices válidos vão de 1 até GetStringListCount(StringListID), inclusive. Os itens não são numerados a partir de zero
As listas de cadeias pertencem à instância PDFlib que as produziu e são libertadas automaticamente quando a instância é destruída. Chame ReleaseStringList se pretender libertar uma lista mais cedo — por exemplo, num processo de longa duração que valide muitos ficheiros 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;