ILockBytes::ReadAt

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method reads a specified number of bytes starting at a specified offset from the beginning of the array.

Syntax

HRESULT ReadAt( 
  ULARGE_INTEGER ulOffset, 
  void* pv, 
  ULONG cb, 
  ULONG* pcbRead 
);

Parameters

• ulOffset
  [in] Starting point from the beginning of the byte array for reading data.

• pv
  [in] Pointer to the buffer into which the byte array is read.

• cb
  [in] Number of bytes of data to attempt to read from the byte array.

• pcbRead
  [out] Pointer to a location where this method writes the actual number of bytes read from the byte array.

  You can set this pointer to NULL to indicate that you are not interested in this value. In this case, this method does not provide the actual number of bytes read.

Return Value

The following table shows the return values for this method.

Remarks

ILockBytes::ReadAt reads bytes from the byte array object. It reports the number of bytes that were actually read.

This value may be less than the number of bytes requested if an error occurs or if the end of the byte array is reached during the read.

It is not an error to read less than the specified number of bytes if the operation encounters the end of the byte array. (This is the same end-of-file behavior as found in MS-DOS FAT file system files.)

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements