ecl-logo Documentation

CancelDiscardSamples

CancelDiscardSamples[Objects]UpdatedObjects

cancels pending discard requests for Objects to ensure they will not be discarded as part of the regular maintenance schedule.

Details

  • This function cancels the pending disposal request initiated by the function DiscardSamples, provided the samples have not yet been physically discarded as part of regular maintenance schedule.
  • StoreSamples may also be used to ensure that samples marked for disposal will not be disposed.
  • This function will have no effect on samples that do not have a pending disposal request.
  • Input
    Output

Examples

Basic Examples  (3)

Cancel a disposal request for multiple samples and containers:

Cancel a pending disposal request for a container and the samples in it to ensure they are not permanently discarded as part of regular maintenance:

Cancel a pending disposal request for a sample to ensure it is not permanently discarded as part of regular maintenance:

Additional Examples  (3)

The sample's DisposalLog reflects the change to the discarded request:

This function can be safely run on a sample that is not marked for disposal; it will have no effect:

This function will ensure that the AwaitingDisposal flag is set to Null for both a sample and its container:

Messages  (2)

ContainerConflict  (1)

If not all samples within the same container are undiscarded, a warning will be displayed:

SamplesAlreadyDiscarded  (1)

A warning is thrown if any provided samples have already been permanently thrown away; these samples will be ignored:

Last modified on Thu 3 Aug 2023 16:52:34