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

PHYSFS_removeFromSearchPath

Remove a directory or archive from the search path.

Deprecated

As of PhysicsFS 2.1, use PHYSFS_unmount() instead. This function just wraps it anyhow. There's no functional difference except the vocabulary changed from "adding to the search path" to "mounting" when that functionality was extended, and thus the preferred way to accomplish this function's work is now called "unmounting."

Header File

Defined in <physfs.h>

Syntax

int PHYSFS_removeFromSearchPath(const char *oldDir);

Function Parameters

const char * oldDir dir/archive to remove.

Return Value

(int) Returns nonzero on success, zero on failure. Use PHYSFS_getLastErrorCode() to obtain the specific error.

Remarks

This function is equivalent to:

PHYSFS_unmount(oldDir);

You must use this and not PHYSFS_unmount 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.