##### [API function]

## FMUSIC_IsFinished

Returns whether the song has completed playing, or when the last order has finished playing.
This stays set even if the song loops.

signed char F_API FMUSIC_IsFinished(
FMUSIC_MODULE *mod
);

### Parameters

mod | Pointer to the song that you want check if finished or not.

### Return Value

TRUE Song has finished playing.
FALSE Song has not finished playing.

### Remarks

Some songs may use a pattern break or pattern jump and never reach the last pattern.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:26 2005 by SourceDoc v0.10, the automated source code documenter.