Scripting: SetFxOpCnxFlag

SetFxOpCnxFlag

Introduced

v3.0

Description

Changes the specifed flag on a connection of the FxOperator.

Scripting Syntax

SetFxOpCnxFlag( [FxOp], Connection, FlagName, [Value] );

Parameters

Parameter

Type

Description

FxOp

String or FxOperator

Object pointer or Object name for FxOperator.

Default Value: Current selection.

Note: If the current selection is not a valid FxOperator, an error occurs.

Connection

String

Index or name of the connection.

Note: the index is 1-based (ie., the index starts at 1 instead of 0), and you must use quotation marks around the index value. For example, "1", "2", etc.

FlagName

String

Type of flag.

Possible Values:	Description:
Select	Specifies the Select flag
Invert	Specifies the Invert flag

Value

Boolean

New value of the flag.

Default Value: True

Examples

VBScript Example

' This example creates an FxTree, adds the Noise operator
' to it and then sets the flag on the Obey Matte 
' connection to True
set oTree = CreateFxTree()
set oOperator = AddFxOp( oTree, "Noise" )
SetFxOpCnxFlag oOperator, "Obey Matte", "Select", False