The IAAFHeader interface provides file-wide information and indexes. More...

Public Member Functions
HRESULT	LookupMob ([in, ref] aafMobID_constref mobID,[out, retval] IAAFMob **ppMob)
	Looks up the Mob that matches the given mob id and puts it into the ppMob argument.
HRESULT	CountMobs ([in] aafMobKind_t mobKind,[out, retval] aafNumSlots_t *pResult)
	Writes the number of matches for the given mob kind into the pNumMobs argument.
HRESULT	GetMobs ([in] aafSearchCrit_t pSearchCriteria,[out, retval] IEnumAAFMobs *ppEnum)
	Places an enumerator for mobs that apply to the criteria into the ppEnum argument.
HRESULT	AddMob ([in] IAAFMob *pMob)
	Appends the given mob to the header.
HRESULT	RemoveMob ([in] IAAFMob *pMob)
	Removes the given mob from the header.
HRESULT	CountEssenceData ([out, retval] aafUInt32 *pResult)
	Writes the total number of essence data into the *pNumEssenceData argument.
HRESULT	IsEssenceDataPresent ([in, ref] aafMobID_constref fileMobID,[in] aafFileFormat_t fmt,[out, retval] aafBoolean_t *pResult)
	Returns true if the essence is found.
HRESULT	EnumEssenceData ([out, retval] IEnumAAFEssenceData **ppEnum)
	Places an enumerator for essence that applies to the criteria into the *ppEnum argument.
HRESULT	AddEssenceData ([in] IAAFEssenceData *pEssenceData)
	Appends the given essence data object to the header.
HRESULT	RemoveEssenceData ([in] IAAFEssenceData *pEssenceData)
	Removes the given EssenceData from the header.
HRESULT	LookupEssenceData ([in, ref] aafMobID_constref mobID,[out, retval] IAAFEssenceData **ppEssenceData)
	Looks up the EssenceData that matches the given mob id and puts it into the ppEssenceData argument.
HRESULT	GetDictionary ([out, retval] IAAFDictionary **ppDictionary)
	Places the dictionary that contains all types of aaf definition objects into the *ppDictionary argument.
HRESULT	GetLastIdentification ([out, retval] IAAFIdentification **ppIdentification)
	Places the identification of the last entity that modified the file into the *ppIdentification argument.
HRESULT	LookupIdentification ([in, ref] aafUID_constref generation,[out, retval] IAAFIdentification **ppIdentification)
	Places the Identification that matches the given generation into the *ppIdentification argument.
HRESULT	CountIdentifications ([out, retval] aafUInt32 *pResult)
	Writes the number of identification objects into the *pResult argument.
HRESULT	GetIdentifications ([out, retval] IEnumAAFIdentifications **ppEnum)
	Places an enumerator for all Identifications criteria into the ppEnum argument.
HRESULT	AppendIdentification ([in] IAAFIdentification *pIdent)
	Appends the given Identification class to the header.
HRESULT	GetIdentificationAt ([in] aafUInt32 index,[out, retval] IAAFIdentification **ppIdentification)
	Retrieves the indexed identification from the header.
HRESULT	GetRefImplVersion ([out, retval] aafProductVersion_t *pVersion)
	Return the version of the Reference Implementation currently running on this machine, which implements these interfaces.
HRESULT	GetFileRevision ([out, retval] aafVersionType_t *pRevision)
	Return the File Revision property.
HRESULT	GetLastModified ([out, retval] aafTimeStamp_t *pTimeStamp)
	Return the Last Modified property.
HRESULT	GetContentStorage ([out] IAAFContentStorage **ppStorage)
	Places the Content Storage object attached to the header into the ppStorage argument.

Detailed Description

The IAAFHeader interface provides file-wide information and indexes.

Each AAF file has one and only one instance of an object which supports IAAFHeader.

When an IAAFHeader-supporting object is created, the contained dictionary object is automatically created.

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 IAAFHeader also implement the following interfaces:

IAAFObject

Definition at line 11058 of file AAF.idl.

Member Function Documentation

HRESULT IAAFHeader::AddEssenceData ( [in] IAAFEssenceData * pEssenceData )

Appends the given essence data object to the header.

Succeeds if all of the following are true:

the pEssenceData pointer is valid.

If this method fails no state will be changed.

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_DUPLICATE_MOBID

The given mob has already been added. The validation is done by comparing mobIDs, which should be unique.

AAFRESULT_NULL_PARAM

pEssenceData is null.

Parameters:

pEssenceData [in] Essence data object to append

HRESULT IAAFHeader::AddMob ( [in] IAAFMob * pMob )

Appends the given mob to the header.

If the given mob is already contained this method will do nothing and will return success.

Succeeds if all of the following are true:

the pMob pointer is valid.
the given mob is not already part of this collection.

If this method fails no state will be changed.

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

pMob is null.

AAFRESULT_DUPLICATE_MOBID

the given mob is already contained.

Parameters:

pMob	[in] Mob to add

HRESULT IAAFHeader::AppendIdentification ( [in] IAAFIdentification * pIdent )

Appends the given Identification class to the header.

This method does not attempt to identify duplicate identifications, so it will succeed even if an identical identification has already been appended.

Succeeds if all of the following are true:

the pIdent pointer is valid.

If this method fails no state will be changed.

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

pIdent is null.

Parameters:

pIdent [in] Identification to append

HRESULT IAAFHeader::CountEssenceData ( [out, retval] aafUInt32 * pResult )

Writes the total number of essence data into the *pNumEssenceData argument.

Succeeds if all of the following are true:

the pNumEssenceData pointer is valid.

If this method fails nothing will be written to pNumEssenceData.

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

pNumEssenceData is null.

Parameters:

pResult [out, retval] Total number of essence data

HRESULT IAAFHeader::CountIdentifications ( [out, retval] aafUInt32 * pResult )

Writes the number of identification objects into the *pResult argument.

Succeeds if all of the following are true:

the pResult pointer is valid.

If this method fails nothing will be written to *pResult.

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

pResult is null.

Parameters:

pResult [out, retval] Total number of identification objects

HRESULT IAAFHeader::CountMobs	(	[in] aafMobKind_t	mobKind,
		[out, retval] aafNumSlots_t *	pResult
	)

Writes the number of matches for the given mob kind into the pNumMobs argument.

Succeeds if all of the following are true:

the pNumMobs pointer is valid.

If this method fails nothing will be written to *pNumMobs.

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

pNumMobs is null.

Parameters:

mobKind	[in] The mob kind to count
pResult	[out, retval] Total number of mobs of kind mobKind

HRESULT IAAFHeader::EnumEssenceData ( [out, retval] IEnumAAFEssenceData ** ppEnum )

Places an enumerator for essence that applies to the criteria into the *ppEnum argument.

The returned enumerator is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the pMediaCriteria pointer is valid.
the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.

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

either pMediaCriteria or ppEnum is null.

Parameters:

ppEnum [out,retval] Essence Enumeration

HRESULT IAAFHeader::GetContentStorage ( [out] IAAFContentStorage ** ppStorage )

Places the Content Storage object attached to the header into the ppStorage argument.

The returned content storage object is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppStorage 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_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

ppStorage is null.

Parameters:

ppStorage [out] Returned Content Storage object

HRESULT IAAFHeader::GetDictionary ( [out, retval] IAAFDictionary ** ppDictionary )

Places the dictionary that contains all types of aaf definition objects into the *ppDictionary argument.

The returned dictionary is AddRef()ed before it is returned. Note that the dictionary is automatically created when the header object is created.

Succeeds if all of the following are true:

the ppDictionary pointer is valid.

If this method fails no state will be changed.

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

ppDictionary is null.

Parameters:

ppDictionary [out, retval] The AAF Dictionary

HRESULT IAAFHeader::GetFileRevision ( [out, retval] aafVersionType_t * pRevision )

Return the File Revision property.

Succeeds if all of the following are true:

the pRevision pointer is valid.

If this method fails nothing is written to *pRevision.

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

pRevision is null.

Parameters:

pRevision [out, retval] The File Version

HRESULT IAAFHeader::GetIdentificationAt	(	[in] aafUInt32	index,
		[out, retval] IAAFIdentification **	ppIdentification
	)

Retrieves the indexed identification from the header.

Succeeds if all of the following are true:

the ppIdentification pointer is valid.
index is less than the value returned by CountIdentifications().

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

ppIdent is null.

AAFRESULT_BADINDEX

index is greater than or equal to result of CountIdentifications().

Parameters:

index	[in] Index of identification to retrieve
ppIdentification	[out, retval] Retrieved identification

HRESULT IAAFHeader::GetIdentifications ( [out, retval] IEnumAAFIdentifications ** ppEnum )

Places an enumerator for all Identifications criteria into the ppEnum argument.

The returned enumerator is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.

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

ppEnum is null.

Parameters:

ppEnum [out,retval] Indentification Enumeration

HRESULT IAAFHeader::GetLastIdentification ( [out, retval] IAAFIdentification ** ppIdentification )

Places the identification of the last entity that modified the file into the *ppIdentification argument.

The returned identification is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppIdentification pointer is valid.

If this method fails no state will be changed.

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

ppIdentification is null.

Parameters:

ppIdentification [out,retval] Indentification Object

HRESULT IAAFHeader::GetLastModified ( [out, retval] aafTimeStamp_t * pTimeStamp )

Return the Last Modified property.

Succeeds if all of the following are true:

the pTimeStamp pointer is valid.

If this method fails nothing is written to *pTimeStamp.

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

pTimeStamp is null.

Parameters:

pTimeStamp [out, retval] The modification date-time stamp

HRESULT IAAFHeader::GetMobs	(	[in] aafSearchCrit_t *	pSearchCriteria,
		[out, retval] IEnumAAFMobs **	ppEnum
	)

Places an enumerator for mobs that apply to the criteria into the ppEnum argument.

If pSearchCriteria is null, all mobs are returned. The searchTag field of pSearchCriteria, and exactly ONE of the fields in the union (tags.mobID, tags.name, etc. ) must be set. Only one search criterion may be specified. The returned enumerator is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.

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

ppEnum is null.

Parameters:

pSearchCriteria	[in] Search Criteria for enumeration
ppEnum	[out, retval] Mob Enumeration

HRESULT IAAFHeader::GetRefImplVersion ( [out, retval] aafProductVersion_t * pVersion )

Return the version of the Reference Implementation currently running on this machine, which implements these interfaces.

Succeeds if all of the following are true:

the pVersion pointer is valid.

If this method fails nothing is written to *pVersion.

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

pVersion is null.

Parameters:

pVersion [out, retval] The Reference Implementation Version

HRESULT IAAFHeader::IsEssenceDataPresent	(	[in, ref] aafMobID_constref	fileMobID,
		[in] aafFileFormat_t	fmt,
		[out, retval] aafBoolean_t *	pResult
	)

Returns true if the essence is found.

Succeeds if all of the following are true:

the pResult pointer is valid.

If this method fails no state will be changed.

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

pResult is null.

Parameters:

fileMobID	[in, ref] A Unique File Mob ID
fmt	[in] The Essence File Format
pResult	[out,retval] True if the essence is found

HRESULT IAAFHeader::LookupEssenceData	(	[in, ref] aafMobID_constref	mobID,
		[out, retval] IAAFEssenceData **	ppEssenceData
	)

Looks up the EssenceData that matches the given mob id and puts it into the ppEssenceData argument.

The returned EssenceData interface is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppEssenceData pointer is valid.

If this method fails nothing will be written to *ppEssenceData.

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

ppEssenceData is null

AAFRESULT_MOB_NOT_FOUND

the requested EssenceData wasn't found.

Parameters:

mobID	[in, ref] The Mob ID
ppEssenceData	[out,retval] Matching EssenceData

HRESULT IAAFHeader::LookupIdentification	(	[in, ref] aafUID_constref	generation,
		[out, retval] IAAFIdentification **	ppIdentification
	)

Places the Identification that matches the given generation into the *ppIdentification argument.

The returned identification is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppIdentification pointer is valid.
the given generation was found.

If this method fails no state will be changed.

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

ppIdentification is null.

AAFRESULT_OBJECT_NOT_FOUND

the given generation was not found..

Parameters:

generation	[in, ref] Unique Generation ID
ppIdentification	[out,retval] Indentification Object

HRESULT IAAFHeader::LookupMob	(	[in, ref] aafMobID_constref	mobID,
		[out, retval] IAAFMob **	ppMob
	)

Looks up the Mob that matches the given mob id and puts it into the ppMob argument.

The returned mob interface is AddRef()ed before it is returned.

Succeeds if all of the following are true:

the ppMob pointer is valid.

If this method fails nothing will be written to *ppMob.

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

ppMob is null

AAFRESULT_MOB_NOT_FOUND

the requested mob wasn't found.

Parameters:

mobID	[in, ref] The Mob ID
ppMob	[out,retval] Matching Mob

HRESULT IAAFHeader::RemoveEssenceData ( [in] IAAFEssenceData * pEssenceData )

Removes the given EssenceData from the header.

Succeeds if all of the following are true:

the pEssenceData pointer is valid.
the given EssenceData is currently in the collection.

If this method fails no state will be changed.

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

pEssenceData is null.

AAFRESULT_ESSENCE_NOT_FOUND

the given EssenceData is not already contained.

Parameters:

pEssenceData [in] EssenceData to remove

HRESULT IAAFHeader::RemoveMob ( [in] IAAFMob * pMob )

Removes the given mob from the header.

Succeeds if all of the following are true:

the pMob pointer is valid.
the given mob is currently in the collection.

If this method fails no state will be changed.

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

pMob is null.

AAFRESULT_MOB_NOT_FOUND

the given mob is not already contained.

Parameters:

pMob	[in] Mob to remove

Public Member Functions

Detailed Description

Member Function Documentation