Description


Include file: xfile.h

Parent class: XIO

Overview

Functions

CreateDirectory

Parameters

char * path path of the directory to create

Remarks

Creates a directory

DeleteDirectory

Parameters

char * path path of the directory to delete

Remarks

Delete a directory

GetCurrentDirectory

Parameters

XString * buffer buffer to hold the data

Remarks

Query the current directory

GetCurrentDisk

Parameters

char& buffer buffer to hold data (will contain A,B,..)

Remarks

Query the current disk

IsDriveAvaible

Parameters

char drive the drive (A, B, ....)

Return-Value

BOOL result

Remarks

Query if a drive is avaible or not

SetDefaultDisk

Parameters

char drive the drive (A, B, ....)

Remarks

Set the dault disk

Copy

Parameters

char * from file to copy (including path if nessecary)
char * to destination (including path if nessecary)

Return-Value

ULONG result returncode from the OS.

Remarks

Copy a file

GetFileInfo

Parameters

XFileInfo * info pointer to an instance of XFileInfo

Return-Value

LONG result of the operatingsystem

Remarks

Query information about files. To access information the file must be open and XFILE_SHARE_DENYWRITE must be set!

Move

Parameters

char * from file to copy (including path if nessecary)
char * to destination (including path if nessecary). If the same directory is given, Move() renames the file.

Return-Value

ULONG result returncode from the OS.

Remarks

Move a file

Remove

Parameters

char * fileName name of the file to delete (including path if nessecary)

Return-Value

BOOL success

Remarks

Delete a file

ResetBuffer

Return-Value

ULONG result returncode from the OS.

Remarks

Wait until all writen datas are physicaly saved

Open

Parameters

char * path the path of the file
ULONG modeForOpen how to open, possible values are:
XFILE_REPLACE_EXISTING override existing filea
XFILE_OPEN_EXISTING open if file exists
XFILE_FAIL_EXISTING cancel if the file exists
XFILE_FAIL_IF_NEW cancel if the file doesn∩t exist
XFILE_CREATE_IF_NEW create a new file if it doesn∩t exist

(can be or-ed)
ULONG accessMode mode for file-sharing and access, possible values are:
XFILE_SHARE_DENYREAD
XFILE_SHARE_DENYWRITE
XFILE_SHARE_DENYREADWRITE
XFILE_SHARE_DENYNONE
XFILE_READONLY
XFILE_WRITEONLY
XFILE_READWRITE

(can be or-ed)
ULONG size size to open (only if a file is created, default is 0)
EAOP2 * eaList list with extended attributes (default is NULL)

Return-Value

ULONG result returned by the OS

Remarks

Open a file


This document was generated by Jens von Pilgrim's Autodoc