IAAFGetFileBits Interface Reference

This interface is implemented by the toolkit, and is provided to clients of IAAFFile to allow them to obtain the raw bits of a file after close. More...

List of all members.

Public Member Functions
HRESULT	ReadAt ([out, size_is(bufSize)] aafMemPtr_t buf,[in] aafUInt32 bufSize,[in] aafUInt64 position)
	Attempts to read bufsize bytes from this stream at the given byte offset.
HRESULT	GetSize ([out] aafUInt64 *pSize)
	Returns the size of this file, in bytes, in *pSize.

---

Detailed Description

This interface is implemented by the toolkit, and is provided to clients of IAAFFile to allow them to obtain the raw bits of a file after close.

Note that this and the IAAFSetFileBits interfaces are different than the IAAFRawStorage interfaces in that those are implemented by clients to provide access to the desired media; these are provided by the toolkit to provide read OR write (but not both simultaneously) access to the raw bits.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

• insufficient system memory is available to perform the operation.

Definition at line 10958 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFGetFileBits::GetSize

(

[out] aafUInt64 *

pSize

)

Returns the size of this file, in bytes, in *pSize.

Succeeds if:

• The pSize pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• pSize arg is NULL.

Parameters:

pSize

[out] The size of this file in bytes

HRESULT IAAFGetFileBits::ReadAt	(	[out, size_is(bufSize)] aafMemPtr_t	buf,
		[in] aafUInt32	bufSize,
		[in] aafUInt64	position
	)

Attempts to read bufsize bytes from this stream at the given byte offset.

Places the data into buf. Any attempt to read beyond the size of this file, as reported by GetSize(), will be considered an error.

A value of zero for position indicates the beginning of the stream.

Succeeds if:

• The pNumBytes pointer is valid.
• position + buSize is not larger than the size of this file, as reported by GetSize().

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• buf arg is NULL.

AAFRESULT_OFFSET_SIZE

• position + size is larger than the size of this file.

Parameters:

buf	[out, size_is(bufSize)] Buffer into which data is read
bufSize	[in] Size of buf in bytes
position	[in] The position in bytes at which to read