Method ITcFileAccess:FileRead

Reads data from a file.

Syntax

virtual HRESULT TCOMAPI
FileRead(TcFileHandle hFile, PVOID pData, UINT cbData, PUINT pcbRead);

Method ITcFileAccess:FileRead 1: 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.

Parameter

Name

Type

Description

hFile

TcFileHandle

[in] refers to the previously opened file.

pData

PVOID

[out] storage location of the data to be read.

cbData

PVOID

[in] maximum size of the data to be read (size of the memory behind pData).

pcbRead

PUINT

[out] size of the data read.