GetStringListCount

Diverse funktioner

Beskrivning

Returnerar antalet strängar som lagrats i en stränglista skapad av en annan API-funktion. Den vanligaste producenten är CheckFileCompliance, som returnerar ett icke-noll StringListID vars poster listar efterlevnadsproblemen som hittats i det validerade dokumentet

Syntax

Delphi

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

ActiveX

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

DLL

int DLGetStringListCount(int InstanceID, int StringListID);

Parametrar

StringListID	ID:t på stränglistan som en produktionsfunktion som CheckFileCompliance returnerade. Måste referera en stränglista som den aktuella PDFlib-instansen äger

Returvärden

0	Listan är tom, eller StringListID refererar inte en giltig stränglista som denna instans äger
> 0	Antalet strängar som för tillfället finns i listan

Anmärkningar

Det returnerade antalet är den övre gränsen för ItemIndex-argumentet i GetStringListItem: giltiga index är 1 till GetStringListCount(StringListID), inklusive. Posterna numreras inte från noll

Stränglistor ägs av den PDFlib-instans som producerade dem och frigörs automatiskt när instansen förstörs. Anropa ReleaseStringList om du vill släppa en lista tidigare än så — till exempel i en långlivad process som validerar många filer i sekvens

Exempel

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

Se även

GetStringListItem, ReleaseStringList, CheckFileCompliance