GetStringListCount
Fonctions diverses
Description
Renvoie le nombre de chaînes stockées dans une liste créée par une autre fonction d’API. Le producteur le plus courant est CheckFileCompliance, qui renvoie un StringListID non nul dont les entrées énumèrent les problèmes de conformité du document validé
Syntaxe
Delphi
Function TPDFlib.GetStringListCount(StringListID: Integer): Integer;ActiveX
Function PDFlib::GetStringListCount(StringListID As Long) As LongDLL
int DLGetStringListCount(int InstanceID, int StringListID);Paramètres
| StringListID | ID de liste de chaînes renvoyé par une fonction telle que CheckFileCompliance. Doit référencer une liste appartenant à l'instance PDFlib actuelle |
|---|
Valeurs de retour
| 0 | La liste est vide, ou StringListID ne référence pas une liste de chaînes valide appartenant à cette instance |
|---|---|
| > 0 | Nombre de chaînes actuellement présentes dans la liste |
Remarques
Le nombre renvoyé constitue la limite supérieure de l’argument ItemIndex de GetStringListItem : les index valides vont de 1 à GetStringListCount(StringListID) inclus. Les éléments ne sont pas numérotés à partir de zéro
Les listes de chaînes appartiennent à l’instance PDFlib qui les a produites et sont libérées automatiquement à sa destruction. Appelez ReleaseStringList pour libérer une liste plus tôt, par exemple dans un processus de longue durée qui valide de nombreux fichiers successivement
Exemple
// 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;