GetOptionalContentConfigState

Content Streams and Optional Content Groups

Version history

This function was introduced in Quick PDF Library version 7.21.

Description

This function is used to determine the state of an optional content group as defined by the specified optional content configuration dictionary.

Syntax

Delphi

function TQuickPDF0813.GetOptionalContentConfigState(OptionalContentConfigID, 
  OptionalContentGroupID: Integer): Integer;

ActiveX

Function QuickPDF0813.PDFLibrary::GetOptionalContentConfigState(
  OptionalContentConfigID As Long, OptionalContentGroupID As Long) As Long

DLL

int QuickPDFGetOptionalContentConfigState(int InstanceID,
  int OptionalContentConfigID, int OptionalContentGroupID)

Parameters

OptionalContentConfigID	The first default optional content configuration dictionary has an ID of 1. Higher numbers are used for other optional content configuration dictionaries.
OptionalContentGroupID	An ID returned by the NewOptionalContentGroup, GetOptionalContentGroupID or GetOptionalContentConfigOrderItemID functions

Return values

0	The OptionalContentConfigID parameter or the OptionalContentGroupID parameter is not valid.
1	The state of the optional content group is set to ON when this optional content configuration dictionary is applied.
2	The state of the optional content group is set to OFF when this optional content configuration dictionary is applied.
3	The state of the optional content group is not changed when this optional content configuration dictionary is applied.