Description

This command retrieves the status of the active flag for parameter pickups.  When the pickup flag is true, pickups are applied to the document on update.  When the pickup flag is false, pickups are ignored.

Syntax

pFlag = GetPickupsActiveFlag()

Parameters

pFlag (Boolean)

Boolean indicating whether pickups are active (True) or inactive (False).

Example

The following example deactivates parameter pickups if they are active.

Sub Main

    Dim pFlag As Boolean

    pFlag = GetPickupsActiveFlag()

    If pFlag Then

        SetPickupsActiveFlag( Not pFlag )

    End If

End Sub

See Also

Pickup Script Commands