Debenu Quick PDF logo

GetOptionalContentConfigOrderItemType

Content Streams and Optional Content Groups

Version history

This function was introduced in Quick PDF Library version 7.21.

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 TDebenuPDFLibrary1511.GetOptionalContentConfigOrderItemType(
  OptionalContentConfigID, ItemIndex: Integer): Integer;

ActiveX

Function DebenuPDFLibrary1511.PDFLibrary::GetOptionalContentConfigOrderItemType(
  OptionalContentConfigID As Long, ItemIndex As Long) As Long

DLL

int DPLGetOptionalContentConfigOrderItemType(int InstanceID,
  int OptionalContentConfigID, int ItemIndex)

Parameters

OptionalContentConfigID The first default optional content configuration dictionary has an ID of 1. Higher numbers are used for other optional content configuration dictionaries.
ItemIndex The 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

0 The specified item could not be found
1 The specified item is an optional content group. The GetOptionalContentConfigOrderItemID function can be used to detemine the OptionalContentGroupID.
2 The specified item is a text label.

Copyright © 2014 Debenu. All rights reserved. AboutContactBlogNewsletterSupport