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

PHYSFS_addToSearchPath

Add an archive or directory to the search path.

Deprecated

As of PhysicsFS 2.0, use PHYSFS_mount() instead. This function just wraps it anyhow.

Header File

Defined in <physfs.h>

Syntax

int PHYSFS_addToSearchPath(const char *newDir, int appendToPath);

Function Parameters

const char * newDir directory or archive to add to the path, in platform-dependent notation.
int appendToPath nonzero to append to search path, zero to prepend.

Return Value

(int) Returns nonzero if added to path, zero on failure (bogus archive, dir missing, etc). Use PHYSFS_getLastErrorCode() to obtain the specific error.

Remarks

This function is equivalent to:

PHYSFS_mount(newDir, NULL, appendToPath);

You must use this and not PHYSFS_mount if binary compatibility with PhysicsFS 1.0 is important (which it may not be for many people).

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.