Function physfs_sys::PHYSFS_getUserDir[][src]

pub unsafe extern "C" fn PHYSFS_getUserDir() -> *const c_char
Expand description

\fn const char *PHYSFS_getUserDir(void) \brief Get the path where user’s home directory resides.

\deprecated As of PhysicsFS 2.1, you probably want PHYSFS_getPrefDir().

Helper function.

Get the “user dir”. This is meant to be a suggestion of where a specific user of the system can store files. On Unix, this is her home directory. On systems with no concept of multiple home directories (MacOS, win95), this will default to something like “C:\mybasedir\users\username” where “username” will either be the login name, or “default” if the platform doesn’t support multiple users, either.

\return READ ONLY string of user dir in platform-dependent notation.

\sa PHYSFS_getBaseDir \sa PHYSFS_getPrefDir