GetOptionalContentConfigOrderItemID

Content Streams and Optional Content Groups

Description

Returns the OptionalContentGroupID for an item in the order array of the specified optional content configuration dictionary.

Syntax

Delphi

function TPDFlib.GetOptionalContentConfigOrderItemID(OptionalContentConfigID, ItemIndex: Integer): Integer;

ActiveX

Function PDFlib::GetOptionalContentConfigOrderItemID(OptionalContentConfigID As Long, ItemIndex As Long) As Long

DLL

int DLGetOptionalContentConfigOrderItemID(int InstanceID, int OptionalContentConfigID, int ItemIndex);

Parameters

OptionalContentConfigIDThe first default optional content configuration dictionary has an ID of 1. Higher numbers are used for other optional content configuration dictionaries.
ItemIndexThe index number of the item in the order array. The first item has an index number of 1 and the last item has an index equal to the value returned by the GetOptionalContentConfigOrderCount function.

Return values

0The specified item could not be found or it is a label item and does not have an associated optional content group.
Non-zeroThe OptionalContentGroupID of the item