Method ITcFileAccess:FileWrite

Write data to a file.

Syntax

virtual HRESULT TCOMAPI
FileWrite(TcFileHandle hFile, PCVOID pData, UINT cbData, PUINT pcbWrite);

Parameter

hFile: (type: TcFileHandle) [in] refers to the previously opened file.

pData: (type: PVOID) [in] storage location of the data to be written.

cbData: (type: PVOID) [in] size of the data to be written (size of the memory behind pData).

pcbRead: (type: PUINT) [out] size of the written data.

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

This method writes data to a file defined by the file handle. Data will be read from pData while pcbRead provides length of data.