GetOptionalContentConfigOrderItemType

Content Streams and Optional Content Groups

Description

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

Items are either optional content groups or text labels.

Syntax

Delphi

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

ActiveX

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

DLL

int DLGetOptionalContentConfigOrderItemType(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 The specified item is an optional content group. The GetOptionalContentConfigOrderItemID function can be used to detemine the OptionalContentGroupID.
1The specified item is a text label. 2