ecl-logo Documentation

CancelDiscardSamplesOptions

CancelDiscardSamplesOptions[objects]resolvedOptions

returns the resolved options for CancelDiscardSamples when it is called on objects.

Details

  • This function returns the resolved options that would be fed to CancelDiscardSamples if it were called on these input objects.
  • Input
    Output
    General Options

Examples

Basic Examples  (3)

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

Returns all options to: 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:

Returns all options to: Cancel a disposal request for multiple samples and containers:

Additional Examples  (3)

Returns all options for the case that this function can be safely run on a sample that is not marked for disposal; it will have no effect:

Returns all options to for the case that this function will ensure that the AwaitingDisposal flag is set to Null for both a sample and its container:

Returns all options so that the sample's DisposalLog reflects the change to the discarded request:

Options  (1)

OutputFormat  (1)

Choose to return options as a List or Table:

Messages  (2)

ContainerConflict  (1)

Returns all options: If not all samples within the same container are undiscarded, an error is returned; the entire container and all its samples must be all undiscarded simultaneously:

SamplesAlreadyDiscarded  (1)

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