FMUSIC_GetOrder

##### [API function]

## FMUSIC_GetOrder

Returns the song's current order number

int F_API FMUSIC_GetOrder(
FMUSIC_MODULE *mod
);

### Parameters

mod | Pointer to the song to retrieve current order number from.

### Return Value

On success, the song's current order number is returned.
On failure, -1 is returned.

### Remarks

This value is latency adjusted by default, and returns the number you are hearing, not the 'mix-time' value.
Use FSOUND_INIT_DONTLATENCYADJUST if you want the value at mix time, which is useful if you want to control the music interactively, or from a DSP callback.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FMUSIC_GetPattern , FMUSIC_GetPatternLength , FMUSIC_SetOrder

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