wiki.icculus.org
[ front page | index | search | recent changes | git repo | offline html ]

PHYSFS_getUserDir

Get the path where user's home directory resides.

Deprecated

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

Header File

Defined in <physfs.h>

Syntax

const char * PHYSFS_getUserDir(void);

Return Value

(const char *) Returns READ ONLY string of user dir in platform-dependent notation.

Remarks

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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since PhysicsFS 1.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryPhysicsFS


[ edit | delete | history | feedback | raw ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.