GetStringListCount

雜項函式

描述

傳回另一個 API 函式建立之字串清單中的字串數量。最常見的產生者是 CheckFileCompliance：它傳回非零的 StringListID，條目列出驗證文件中發現的符合性問題。

語法

Delphi

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

ActiveX

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

DLL

int DLGetStringListCount(int InstanceID, int StringListID);

參數

StringListID	字串清單的 ID，由 CheckFileCompliance 這類產生函式傳回。必須指向目前 PDFlib 實例持有的字串清單。

傳回值

0	清單為空，或 StringListID 未指向此實例持有的有效字串清單。
> 0	清單中目前的字串數量。

備註

傳回的數量是 GetStringListItem ItemIndex 參數的上界：有效索引為 1 到 GetStringListCount(StringListID)（含端點）。項目不是從零開始編號。

字串清單由產生它們的 PDFlib 執行個體所擁有，執行個體銷毀時會自動釋放。想提前釋放清單，請呼叫 ReleaseStringList — 例如在依序驗證大量檔案的長時間執行程序中。

範例

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

另見

GetStringListItem, ReleaseStringList, CheckFileCompliance