SetContentStreamOptional

Content Streams and Optional Content Groups

Description

A page in a PDF document has one or more content stream parts that together contain all the PDF page description commands for the page.

This function links the content stream that was selected using the SelectContentStream function to an optional content group. This allows the content stream part to be selectively shown in Acrobat 6 or later.

Syntax

Delphi

function TPDFlib.SetContentStreamOptional(OptionalContentGroupID: Integer): Integer;

ActiveX

Function PDFlib::SetContentStreamOptional(OptionalContentGroupID As Long) As Long

DLL

int DLSetContentStreamOptional(int InstanceID, int OptionalContentGroupID);

Parameters

OptionalContentGroupIDAn ID returned by the NewOptionalContentGroup, GetOptionalContentGroupID or GetOptionalContentConfigOrderItemID functions

Return values

0The OptionalContentGroupID parameter was not valid
1The content stream part was linked to the optional content group successfully