Navigation: Scripting Reference Manual > Functions & Subroutines > SetPickup

 

SetPickup

 

Contact Us: fredsupport@photonengr.com

 

Description

This command sets the parameter values for a pickup entry in the document pickup list.

 

 

Syntax

SetPickup pIndex, tPick

 

 

Parameters

pIndex As Long

Index (0 based) into the document pickup list whose parameters are being set.

 

tPick As T_PICKUP

T_PICKUP data structure whose members define the parameters for the pickup entry being set.

 

 

Example

The following example loops over the document pickups, checks for a string match based on the pickup description and then doubles the B parameter value if a description match is found.

 

Sub Main

 

    Dim curPick As Long

    Dim tPick As T_PICKUP

    For curPick = 0 To GetPickupCount()-1

        GetPickup curPick, tPick

        If tPick.Description = "test" Then

            Print "Pickup found at index: " & curPick

            tPick.parmb = 2*tPick.parmb

            SetPickup curPick, tPick

        End If

    Next curPick

 

End Sub

 

 

See Also

Pickup Script Commands

T_PICKUP

 

 

 

 

 

Copyright © Photon Engineering, LLC