Previous Topic Index Next Topic
[API function]

FSOUND_Sample_GetName

Returns a pointer to a NULL terminated string containing the sample's name.

const char * F_API FSOUND_Sample_GetName(
FSOUND_SAMPLE *sptr
);

Parameters

sptr Pointer to the sample to get the name from.

Return Value

On success, the name of the sample is returned.
On failure, NULL is returned.

Remarks

The name may not always make sense. From a MOD file it contains the sample text entered
by the musician. For non descriptive file formats it just contains the filename.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also



This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Mon Oct 18 11:07:59 2004 by SourceDoc v0.10, the automated source code documenter.