GetStringListCount

Overige functies

Beschrijving

Geeft het aantal strings terug die in een stringlijst staan die door een andere API-functie is aangemaakt. De meest voorkomende producer is CheckFileCompliance, die een StringListID ongelijk aan nul teruggeeft waarvan de entries de conformiteitsbevindingen in het gevalideerde document opsommen

Syntaxis

Delphi

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

ActiveX

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

DLL

int DLGetStringListCount(int InstanceID, int StringListID);

Parameters

StringListIDDe ID van de stringlijst zoals geretourneerd door een producerfunctie zoals CheckFileCompliance. Moet verwijzen naar een stringlijst in eigendom van de huidige PDFlib-instantie

Retourwaarden

0De lijst is leeg, of StringListID verwijst niet naar een geldige stringlijst in eigendom van deze instantie
> 0Het aantal strings dat momenteel in de lijst staat

Opmerkingen

De teruggegeven telling is de bovengrens voor het argument ItemIndex van GetStringListItem: geldige indexen lopen van 1 tot en met GetStringListCount(StringListID). Items worden niet vanaf nul genummerd

Stringlijsten zijn in eigendom van de PDFlib-instantie die ze heeft geproduceerd en worden automatisch vrijgegeven wanneer de instantie wordt vernietigd. Roep ReleaseStringList aan als je een lijst eerder wilt vrijgeven — bijvoorbeeld in een langlopend proces dat veel bestanden achter elkaar valideert

Voorbeeld

// 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;

Zie ook

GetStringListItem, ReleaseStringList, CheckFileCompliance