IAAFRandomFile Interface Reference

Specialized file interface for use with files which exist on storage media which has random access capability. More...

List of all members.

Public Member Functions
HRESULT	GetFileBits ([out] IAAFGetFileBits **ppGetFileBits)
	Since the purpose of this method is to obtain file data after a file has been created, it will only succeed if this file has already been Open()ed and then Close()d, or if it was never opened with write access.
HRESULT	Revert ()
	Reverts this file to the previously-saved state.
HRESULT	SaveAsFile ([in] IAAFFile *pDestFile)
	Associates this file with the storage specified in pDestFile.
HRESULT	SetFileBits ([out] IAAFSetFileBits **ppSetFileBits)
	Since the purpose of this method is to specify file data with which a file is to be created, it will only succeed if this file has not yet been Open()ed.

---

Detailed Description

Specialized file interface for use with files which exist on storage media which has random access capability.

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.

Objects that implement IAAFRandomFile also implement the following interfaces:

• IAAFFile

Definition at line 23161 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFRandomFile::GetFileBits

(

[out] IAAFGetFileBits **

ppGetFileBits

)

Since the purpose of this method is to obtain file data after a file has been created, it will only succeed if this file has already been Open()ed and then Close()d, or if it was never opened with write access.

Succeeds if:

• The ppGetFileBits argument is valid
• This file has been opened for write or modify, and has been subsequently closed.

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

• ppGetFileBits arg is NULL.

AAFRESULT_BADOPEN

• This file has never been opened

AAFRESULT_NOT_WRITEABLE

• This file has never been opened for write or modify

AAFRESULT_BADCLOSE

• This file has not been closed after being opened.

Parameters:

ppGetFileBits

[out] The interface to the GetFileBits object

HRESULT IAAFRandomFile::Revert

(

)

Reverts this file to the previously-saved state.

NOTE! Stub only. Implementation not yet added.

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.)

HRESULT IAAFRandomFile::SaveAsFile

(

[in] IAAFFile *

pDestFile

)

Associates this file with the storage specified in pDestFile.

Any objects contained in pDestFile will be lost.

Behaves in a manner similar to SaveCopyAs(), except that SaveAs() will change this object to be associated with the new file.

Special case: if f->SaveAs(f) is called, passing this as the save-to argument, the operation will save everything including things which have not changed.

NOTE! Stub only. Implementation not yet added.

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.)

Parameters:

pDestFile

[in] The destination file into which the contents of this file are to be written.

HRESULT IAAFRandomFile::SetFileBits

(

[out] IAAFSetFileBits **

ppSetFileBits

)

Since the purpose of this method is to specify file data with which a file is to be created, it will only succeed if this file has not yet been Open()ed.

Succeeds if:

• The ppSetFileBits argument is valid
• This file has not yet been opened.

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

• ppSetFileBits arg is NULL.

AAFRESULT_BADOPEN

• This file has has already been opened

AAFRESULT_NOT_READABLE

• This read or modify has not been specified for this file

Parameters:

ppSetFileBits

[out] The interface to the SetFileBits object