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

PHYSFS_close

Close a PhysicsFS filehandle.

Header File

Defined in <physfs.h>

Syntax

int PHYSFS_close(PHYSFS_File *handle);

Function Parameters

PHYSFS_File * handle handle returned from PHYSFS_open*().

Return Value

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

Remarks

This call is capable of failing if the operating system was buffering writes to the physical media, and, now forced to write those changes to physical media, can not store the data for some reason. In such a case, the filehandle stays open. A well-written program should ALWAYS check the return value from the close call in addition to every writing call!

Thread Safety

Multiple threads can not operate on the same PHYSFS_File at the same time, but they can safely operate on different ones simultaneously.

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.