Remove Update

Command line:
tlapi ‑cSCRAP [‑u] sPart
Library call:
nStatus = TLscrap (sPart, nNxtUpd)
Scripting call:
nStatus = RemoveUpdate (bNxtUpd)

Function

Scrap the current partition update and optionally recreate (initialise) a new update.

Arguments

sPart

The path of the partition for which the update is to be scrapped. The scripting call uses the Partition property to determine the partition.

nNxtUpd

If nNxtUpd is zero, the update is scrapped and the partition reverts to the published phase.

If nNxtUpd is one, the update is scrapped and a new update phase is initialised.

When using the command line, the ‑u flag instructs TopLeaf to create a new update.

bNxtUpd

This applies to the scripting interface only. If this is true, a new update phase (or new release) is created after scrapping the current update.

For additional command line arguments see “Common Flag Arguments”.

Notes

The specified partition must have previously been opened for update using the Next Update API function before the update phase can be scrapped.

The update phase cannot be scrapped if the partition is edit locked, or commit locked. A partition becomes commit locked after a successful call to the Commit API function.

Examples

Command line:

tlapi ‑cSCRAP manuals/topix/volume1

Library call:

/* Scrap the current partition update, don't re-open */
status = TLscrap("manuals/topix/volume1", 0L);

Scripting call:

status = topleaf.RemoveUpdate(false);