Index

XFile

XObject &rarrXFile


public
  • Open
  • ~XFile
  • I/O
  • Read
  • Write
  • constructors/destructors
  • XFile
  • misc
  • QueryPointerPos
  • Remove
  • Seek
  • open/close
  • Close


  • Derrived

    : public XObject

    public

    Open

    Definition

    ULONG Open ( char* filename, ULONG size, ULONG modeifexist, ULONG modeopen, EAOP2* ealist )

    ULONG Open ( char* filename, ULONG size, ULONG modeForOpen, ULONG modeForAcces, EAOP2* ealist=NULL )

    Returns

    ULONG

    ~XFile

    Definition

    ~XFile ( )

    Returns

    -

    I/O

    Read

    read from a file

    Definition

    ULONG Read ( PVOID buffer, ULONG sizeofbuffer )

    Parameters

    : PVOID buffer pointer to memory ULONG size count of bytes to read

    Returns

    ULONG

    ULONG count of bytes which are read

    Write

    write to a file

    Definition

    ULONG Write ( PVOID buffer, ULONG sizeofbuffer )

    Parameters

    : PVOID buffer pointer to memory ULONG size count of bytes to write

    Returns

    ULONG

    ULONG count of bytes which are written

    constructors/destructors

    XFile

    open a file

    Definition

    XFile ( )

    Parameters

    : char * path the path o the file ULONG size size to open (only if a file is created) 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 (cna be orïed) EAOP2 * eaList list with extended attributes (default is NULL)

    Returns

    -

    ULONG result returned by the OS

    misc

    QueryPointerPos

    returns the position of the file-pointer relative to the beginning of the file

    Definition

    ULONG QueryPointerPos ( void )

    Parameters

    : -

    Returns

    ULONG

    ULONG the position

    Remove

    delete a file

    Definition

    static BOOL Remove ( char* path )

    Parameters

    : char * path the path of the file to delete

    Returns

    static BOOL

    BOOL success

    Seek

    seek in the file

    Definition

    ULONG Seek ( LONG pos, ULONG relativePos = XFILE_BEGIN )

    Parameters

    : ULONG position position to seek to relative to relPos ULONG relPos position relative to: XFILE_BEGIN relative to the beginning of the file (default) XFILE_CURRENT relative to current position XFILE_END relative to the end of the file

    Returns

    ULONG

    ULONG count of bytes which are read

    open/close

    Close

    close the file

    Definition

    void Close ( )

    Parameters

    : -

    Returns

    void

    -


    Created by AutoDoc, (C) 1996 by Jens von Pilgrim