Method ITcFileAccess:FileOpen

Opens a file.

Syntax

virtual HRESULT TCOMAPI FileOpen(PCCH szFileName, TcFileAccessMode AccessMode, PTcFileHandle phFile);

Parameter

szFileName: (type: PCCH) [in] the name of the file to be opened.

AccessMode: (type: TcFileAccessMode) [in] method of accessing the file; see TcFileAccessServices.h.

phFile: (type: TcFileHandle) [out] returned file handle.

Return value

If successful, S_OK ("0") or another positive value will be returned, cf. Return values. Extended messages refer in particular to the column HRESULT in ADS Return Codes.

A particularly interesting error code is ADSERR_DEVICE_TIMEOUT if the timeout (5 seconds) has elapsed.

Description

The method returns a handle to access the file, which name is defined in szFileName.

AccessModes could be used as following:

typedef enum TcFileAccessMode
{
    amRead = 0x00000001,
    amWrite = 0x00000002,
    amAppend = 0x00000004,
    amPlus = 0x00000008,
    amBinary = 0x00000010,
    amReadBinary = 0x00000011,
    amWriteBinary = 0x00000012,
    amText = 0x00000020,
    amReadText = 0x00000021,
    amWriteText = 0x00000022,
    amEnsureDirectory = 0x00000040,
    amReadBinaryED = 0x00000051,
    amWriteBinaryED = 0x00000052,
    amReadTextED = 0x00000061,
    amWriteTextED = 0x00000062,
    amEncryption = 0x00000080,
    amReadBinEnc = 0x00000091,
    amWriteBinEnc = 0x00000092,
    amReadBinEncED = 0x000000d1,
    amWriteBinEncED = 0x000000d2,
} TcFileAccessMode, *PTcFileAccessMode;