UnloadSample

Deletes a sample and frees its resources.

Synopsis

Err UnloadSample( Item SampleItem )

Description

This function deletes a sample from memory, freeing its resources. If the sample was created using a custom memory-allocation call, UnloadSample() calls a corresponding custom memory-deallocation call to free the sample's memory.

Arguments

SampleItem
Item number of sample to delete.

Return Value

The function returns 0 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

AttachSample(),DetachSample(), SetAudioItemInfo(), LoadSample(), DebugSample(), CreateSample(), ScanSample(), GetAudioItemInfo()