FS_OpenFile

Syntax

#include <nitro/fs.h>

BOOL FS_OpenFile(FSFile *file, const char *path);

Arguments

file Address of the FSFile structure.
path Path name of file.

Return Values

Returns TRUE if the file opens properly; FALSE otherwise.

Description

This function is the same as FS_OpenFileEx(file, path, FS_FILEMODE_R).
It was created for the sake of compatibility, but now we recommend that you use FS_OpenFileEx.

Note

The structures of opened files are associated with system resources so you cannot move or duplicate information even by copying them to other structures as they are. For details, see FSFile structure.

See Also

FS_OpenFileEx

Revision History

2009/07/14 Added mention that copying the values of the structure is not guaranteed.
2007/09/18 Changed the description so that use of FS_OpenFileEx is recommended.
2004/09/24 Added description in Note regarding the conditions for calling this function.
2004/04/02 Revised Description due to elimination of path length restriction.
2004/04/01 Initial version.


CONFIDENTIAL