`pdfGetOCGUsageUserName`

Enumerate all /User /Name entries registered for a layer (not

Category	Optional content

The generated R07 skeleton for this API carries a Stub status tag; that

is out of date — the implementation calls the real GetOCGUserNameH, which

R07 tag.

Purpose — Enumerate all /User /Name entries registered for a layer (not just the first one, unlike pdfGetOCGContUsage).

Description — Returns the Index-th user name previously appended via repeated pdfSetOCGContUsage calls with a non-empty UserNameA/W.

Declarations

BOOL32 __stdcall pdfGetOCGUsageUserName(PPDF IPDF, uint32_t Handle, uint32_t Index, const char* NameA, const wchar_t* NameW);

Delphi

function pdfGetOCGUsageUserName(const IPDF: PPDF; Handle, Index: Cardinal; var NameA: PAnsiChar; var NameW: PWideChar): LongBool; stdcall; external 'LumasPdf.dll';

Parameters

Parameter	Type	Description
`IPDF`	`PPDF`	Instance handle.
`Handle`	`Cardinal`	OCG handle.
`Index`	`Cardinal`	Zero-based position in the accumulated user-name list.
`NameA`	`PAnsiChar*`	Receives the ANSI name.
`NameW`	`PWideChar*`	Receives the same name as UTF-16 (derived from the ANSI buffer).

Return value — TRUE if Handle is valid and Index is within the accumulated list; FALSE otherwise (including when no usage names were ever registered for this OCG).

Memory & buffers — Both out pointers are backed by the same engine-owned buffer, valid until the next call on this instance.

See also — pdfSetOCGContUsage

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs

[return: MarshalAs(UnmanagedType.Bool)]

Area

Core SDK