FS_GetArchiveName

Syntax

#include <nitro/fs.h>

static inline const char* FS_GetArchiveName(const FSArchive *p_arc);

Arguments

p_arc Address of the FSArchive structure.

Return Values

Pointer to the string representing the name assigned to the archive. If the archive does not have a registered name, the function returns "".

Description

This function gets the string for the name that was given when the archive was registered. The obtained string pointer is temporary and becomes invalid the next time FS_RegisterArchiveName or FS_ReleaseArchiveName is called for that archive.
Further, the contents of this string cannot be changed.

See Also

FSArchive, FS_RegisterArchiveName, FS_ReleaseArchiveName

Revision History

2004/11/02 Deleted a link.
2004/06/30 Initial version.

CONFIDENTIAL