Filesystem Functions.
[API Functions]

Get directory paths. More...

Functions

F2LINK bool F2CALL f2_singleusermode ()
 Checks whether Furnarchy is running in single user mode.
F2LINK const char *F2CALL f2_root ()
 Retrieves Furnarchy's program directory.
F2LINK const char *F2CALL f2_dataroot ()
 Retrieves Furnarchy's data directory.
F2LINK const char *F2CALL f2_docroot ()
 Retrieves Furnarchy's document directory.
F2LINK const char *F2CALL f2_clroot ()
 Retrieves the client's program directory.
F2LINK const char *F2CALL f2_cldataroot ()
 Retrieves the client's data directory.
F2LINK const char *F2CALL f2_cldocroot ()
 Retrieves the client's document directory.
F2LINK bool F2CALL f2_createdirs (const char *path)
 Creates a directory hierarchy.

Detailed Description

Get directory paths.


Function Documentation

F2LINK const char* F2CALL furn2::f2_cldataroot (  ) 

Retrieves the client's data directory.

Returns:
An absolute path to the client's data directory.
Remarks:
This is the folder located in the computer-specific (non-roaming), per-user "Application Data" or "AppData" folder.
See also:
f2_clroot() f2_cldocroot()

F2LINK const char* F2CALL furn2::f2_cldocroot (  ) 

Retrieves the client's document directory.

Returns:
An absolute path to the client's document directory.
Remarks:
This is the folder located in the per-user "My Documents" or "Documents" folder.
See also:
f2_clroot() f2_cldataroot()

F2LINK const char* F2CALL furn2::f2_clroot (  ) 

Retrieves the client's program directory.

Returns:
An absolute path to the client's program directory.
See also:
f2_cldocroot() f2_cldataroot()

F2LINK bool F2CALL furn2::f2_createdirs ( const char *  path  ) 

Creates a directory hierarchy.

Returns:
non-zero on success.
See also:
f2_clroot() f2_cldataroot()

F2LINK const char* F2CALL furn2::f2_dataroot (  ) 

Retrieves Furnarchy's data directory.

Returns:
An absolute path to the furnarchy data directory.
Remarks:
This is the folder located in the per-user "Application Data" or "AppData" folder.
Warning:
If furnarchy is running in single user mode, this directory will be the same as f2_root().
See also:
f2_root() f2_docroot()

F2LINK const char* F2CALL furn2::f2_docroot (  ) 

Retrieves Furnarchy's document directory.

Returns:
An absolute path to the furnarchy document directory.
Remarks:
This is the folder located in the per-user "My Documents" or "Documents" folder.
Warning:
If furnarchy is running in single user mode, this directory will be the same as f2_root().
See also:
f2_root() f2_dataroot()

F2LINK const char* F2CALL furn2::f2_root (  ) 

Retrieves Furnarchy's program directory.

Returns:
An absolute path to the furnarchy program directory.
See also:
f2_dataroot() f2_docroot()

F2LINK bool F2CALL furn2::f2_singleusermode (  ) 

Checks whether Furnarchy is running in single user mode.

Returns:
true if running in single user mode.
Remarks:
In Single user mode, the user has indicated his preference to save all per-user program configuration in the programs folder, like in pre-Vista mode.


Generated on Tue Jun 24 12:24:07 2008 for Furnarchy Module by  doxygen 1.5.5