SetOptionalContentConfigLocked

Content Streams and Optional Content Groups

Description

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

Syntax

Delphi

function TPDFlib.SetOptionalContentConfigLocked(OptionalContentConfigID, OptionalContentGroupID, NewLocked: Integer): Integer;

ActiveX

Function PDFlib::SetOptionalContentConfigLocked(OptionalContentConfigID As Long, OptionalContentGroupID As Long, NewLocked As Long) As Long

DLL

int DLSetOptionalContentConfigLocked(int InstanceID, int OptionalContentConfigID, int OptionalContentGroupID, int NewLocked);

Parameters

OptionalContentConfigIDThe first default optional content configuration dictionary has an ID of 1. Higher numbers are used for other optional content configuration dictionaries.
OptionalContentGroupIDAn ID returned by the NewOptionalContentGroup, GetOptionalContentGroupID or GetOptionalContentConfigOrderItemID functions
NewLocked0 = Unlocked 1 = Locked

Return values

0The optional content group could not be locked
1Success int OptionalContentConfigID, int OptionalContentGroupID, int NewLocked);