FS_GetArchiveName


C Specification

#include <nitro/fs.h>

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

Description

This function gets the character string for the name that was given when the archive was registered.

The obtained character-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.

Arguments

p_arc The address of the FSArchive structure

Return Values

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

See Also

FSArchive, FS_RegisterArchiveName, FS_ReleaseArchiveName

Revision History

06/30/2004 Initial Version