CloseSoundFile

Closes a SoundFilePlayer data structure and unloads a sound file.

Synopsis

int32 CloseSoundFile( SoundFilePlayer *sfp )

Description

This function is a convenience function that closes the specified SoundFilePlayer data structure and also cleans up any items associated with the player. This function is the inverse of OpenSoundFile(), and is in essence a combination of UnloadSoundFile() and DeleteSoundFilePlayer().

Arguments

sfp: A pointer to the SoundFilePlayer.

Return Value

This function returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Convenience call implemented in music.lib V20.

Associated Files

soundfile.h, music.lib