Function physfs_sys::PHYSFS_supportedArchiveTypes[][src]

pub unsafe extern "C" fn PHYSFS_supportedArchiveTypes(
) -> *mut *const PHYSFS_ArchiveInfo
Expand description

\fn const PHYSFS_ArchiveInfo **PHYSFS_supportedArchiveTypes(void) \brief Get a list of supported archive types.

Get a list of archive types supported by this implementation of PhysicFS. These are the file formats usable for search path entries. This is for informational purposes only. Note that the extension listed is merely convention: if we list “ZIP”, you can open a PkZip-compatible archive with an extension of “XYZ”, if you like.

The returned value is an array of pointers to PHYSFS_ArchiveInfo structures, with a NULL entry to signify the end of the list:

\code PHYSFS_ArchiveInfo **i;

for (i = PHYSFS_supportedArchiveTypes(); *i != NULL; i++) { printf(“Supported archive: [%s], which is [%s].\n”, (*i)->extension, (*i)->description); } \endcode

The return values are pointers to internal memory, and should be considered READ ONLY, and never freed. The returned values are valid until the next call to PHYSFS_deinit(), PHYSFS_registerArchiver(), or PHYSFS_deregisterArchiver().

\return READ ONLY Null-terminated array of READ ONLY structures.

\sa PHYSFS_registerArchiver \sa PHYSFS_deregisterArchiver