DeleteEnvelope

Deletes an envelope created by CreateEnvelope().

Synopsis

Err DeleteEnvelope (Item Envelope)

Description

This function deletes the specified envelope, freeing its resources. It also deletes any attachments to the envelope. It does not delete the array of DataTimePairs used to define the envelope, which must be freed directly by the task that created it.

Arguments

Envelope
Item number of the envelope to delete.

Return Value

The function returns a non-negative value if successful or an error code (a negative value) if an error occurs.

Implementation

Folio call implemented in Audio folio V20.

Associated Files

audio.h

See Also

CreateEnvelope(), DetachEnvelope()