Read

Description

Reads bytes from a virtual file.

Syntax

[C#/C++]
public long Read (unsigned char * pBuffer, long lSize)

[VB.NET]
Public Function Read (ByRef pBuffer() As Char, ByVal lSize As Long) As Long

Parameters

pBuffer - a pointer into a buffer into which the contents of the virtual file will be read. The buffer should have been already allocated by the calling code.

lSize - the maximum number of bytes to read from the virtual file.
 

Return values

If the function succeeds, the return value is the number of bytes actually read from the virtual file. This may be less than lSize if the end of the file has been reached before reading the requested number of bytes.

If the function fails, the return value is zero.

See Also

FBVFile::Write  FBVFile::Seek