`pdfGetStringListItem`

Read back one of several internal named string lists

int32_t __stdcall pdfGetStringListCount(PPDF IPDF, int32_t StringListID);
const char* __stdcall pdfGetStringListItemA(PPDF IPDF, int32_t StringListID, int32_t ItemIndex);
const wchar_t* __stdcall pdfGetStringListItemW(PPDF IPDF, int32_t StringListID, int32_t ItemIndex);

Delphi

function pdfGetStringListCount(const IPDF: PPDF; StringListID: Integer): Integer; stdcall;
function pdfGetStringListItemA(const IPDF: PPDF; StringListID, ItemIndex: Integer): PAnsiChar; stdcall;
function pdfGetStringListItemW(const IPDF: PPDF; StringListID, ItemIndex: Integer): PWideChar; stdcall;

Purpose. Read back one of several internal named string lists (resolved via ResolveList(Doc, StringListID) — an opaque ID selecting which specific list, e.g. a Choice field's export values or a similar enumerable string collection produced elsewhere in the ABI; this chapter did not independently enumerate every valid StringListID value).

Parameters.

Parameter	Description
`IPDF`	Document handle.
`StringListID`	Opaque selector for which internal string list to read.
`ItemIndex`	`0`-based index into that list.

Return value. pdfGetStringListCount: the list's item count; 0 if StringListID doesn't resolve. pdfGetStringListItem: the item text (transient buffer), or nil if ItemIndex is out of range.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

public static extern IntPtr pdfGetStringListItemW(IntPtr IPDF, int StringListID, int ItemIndex);
public static extern IntPtr pdfGetStringListItem(IntPtr IPDF, int StringListID, int ItemIndex);
public static extern IntPtr pdfGetStringListItemA(IntPtr IPDF, int StringListID, int ItemIndex);

Area

Core SDK