Navigation: Scripting Reference Manual > Functions & Subroutines > DeletePickup

 

DeletePickup

 

Contact Us: fredsupport@photonengr.com

 

Description

This command deletes a parameter pickup at the specified index from the document pickup list.

 

 

Syntax

pCount = DeletePickup( pIndex )

 

 

Parameters

pCount (Long)

Returned number of pickup entries remaining in the pickup list after deletion of the pickup at pIndex.

 

pIndex As Long

Index into the document pickup list at which the pickup is being deleted.

 

 

Example

The following example loops over all pickup entries in the document pickup list and deletes them.

 

Sub Main

 

    Dim pCount As Long

    pCount = GetPickupCount()

 

    Dim curPick As Long, numPicks As Long

    For curPick = pCount-1 To 0 Step -1

        numPicks = DeletePickup( curPick )

        Print numPicks

    Next curPick

 

End Sub

 

 

See Also

Pickup Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC