XgFS


Data Structures

struct  _dirdesc
 Internally used directory information structure. More...
struct  _FSCP_RENAME
struct  _FSCP_STATUS
struct  _FSCP_VOL_MOUNT
struct  dirent
 Directory entry structure. More...
struct  IOCTL_ARG2
 General structure for two arguments. More...
struct  IOCTL_ARG3
 General structure for three arguments. More...
struct  stat
 File status structure. More...

File System I/O Control Codes

#define FS_DIR_CLOSE   0x1114
 Close a directory stream.
#define FS_DIR_CREATE   0x1111
 Create a new directory entry.
#define FS_DIR_OPEN   0x1113
 Open a directory stream.
#define FS_DIR_READ   0x1115
 Read the next directory entry.
#define FS_DIR_REMOVE   0x1112
 Remove a previously created directory entry.
#define FS_FILE_DELETE   0x1122
 Remove a previously created file.
#define FS_FILE_SEEK   0x1123
 Set a file pointer position.
#define FS_FILE_STATUS   0x1121
 Obtain information about an opened file.
#define FS_STATUS   0x1101
 Obtain information about a specified file entry.

File System Directory Configuration

The Nut/OS Configurator may be used to override the default values.

#define MAXNAMLEN   255
 UDP port of DHCP server.

Defines

#define FS_RENAME   0x1132
#define FS_VOL_MOUNT   0x1130
#define FS_VOL_UNMOUNT   0x1131
#define NUTFS_MKDIR   0x1134
#define NUTFS_RMDIR   0x1135
#define NUTFS_UNLINK   0x1133

Typedefs

typedef _dirdesc DIR
 Internally used directory information structure.
typedef _FSCP_RENAME FSCP_RENAME
typedef _FSCP_STATUS FSCP_STATUS
typedef _FSCP_VOL_MOUNT FSCP_VOL_MOUNT

Functions

int access (CONST char *path, int what)
 Check the accessibility of a file.
int fstat (int fh, struct stat *s)
 Get information about an opened file.
long lseek (int fh, long pos, int whence)
 Reposition a file pointer.
int mkdir (CONST char *path, int mode)
 Create a directory entry.
int rmdir (CONST char *path)
 Remove a directory.
int stat (CONST char *path, struct stat *s)
 Get information about a specified file.
int unlink (CONST char *path)
 Remove a file entry.


Typedef Documentation

typedef struct _dirdesc DIR

Internally used directory information structure.

Applications should ignore its contents.


Function Documentation

int access ( CONST char *  path,
int  what 
)

Check the accessibility of a file.

Parameters:
path Pathname of the file to check.
what Access permission to check.
Returns:
Always -1 due to missing implementation.

int fstat ( int  fh,
struct stat s 
)

Get information about an opened file.

Returns:
Always -1 due to missing implementation.

long lseek ( int  fh,
long  pos,
int  whence 
)

Reposition a file pointer.

Parameters:
fh Handle of an open file.
pos Positioning value.
whence Positioning directive.
Returns:
Always -1 due to missing implementation.

int mkdir ( CONST char *  path,
int  mode 
)

Create a directory entry.

Returns:
0 on success, otherwise -1 is returned.

int rmdir ( CONST char *  path  ) 

Remove a directory.

Parameters:
path Pathname of the directory. Must be the full pathname including the device, because Nut/OS doesn't support relative paths.
Returns:
0 if the remove succeeds, otherwise -1 is returned.

int stat ( CONST char *  path,
struct stat s 
)

Get information about a specified file.

Returns:
0 if the query succeeds, otherwise -1 is returned.

int unlink ( CONST char *  path  ) 

Remove a file entry.

Returns:
0 if the remove succeeds, otherwise -1 is returned.


Generated on Tue Jan 23 21:12:31 2007 for BTnut System Software by doxygen 1.4.7