The IAAFHeader2 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.
HRESULT	GetPrimaryMob ([out, retval] IAAFMob **pPrimaryMob)
	Returns this file's primary mob.
HRESULT	SetPrimaryMob ([in] IAAFMob *pPrimaryMob)
	Sets this file's primary mob.
HRESULT	GetOperationalPattern ([out] aafUID_t *pOperationalPatternID)
	This method returns ID of the operational pattern this file complies to.
HRESULT	SetOperationalPattern ([in] aafUID_constref operationalPatternID)
	Sets operational pattern this file complies to.
HRESULT	UpdateEssenceContainers ()
	Ensures that the contents of the EssenceContainers property is in sync with the file's metadata.
HRESULT	CountEssenceContainers ([out, retval] aafUInt32 *pCount)
	Gets the total number of essence containers present in the file.
HRESULT	GetEssenceContainers ([in] aafUInt32 maxEssenceContainersCount,[out, size_is(maxEssenceContainersCount)] aafUID_t *pEssenceContainerIDs)
	Gets IDs of essence containers present in the file.
HRESULT	IsEssenceContainerPresent ([in, ref] aafUID_constref essenceContainerID,[out, retval] aafBoolean_t *pIsPresent)
	Returns true if the essence container is present.
HRESULT	CountDescriptiveSchemes ([out, retval] aafUInt32 *pCount)
	Gets the total number of descriptive schemes present in the file.
HRESULT	GetDescriptiveSchemes ([in] aafUInt32 maxDescriptiveSchemesCount,[out, size_is(maxDescriptiveSchemesCount)] aafUID_t *pDescriptiveSchemeIDs)
	Gets IDs of descriptive schemes present in the file.
HRESULT	IsDescriptiveSchemePresent ([in, ref] aafUID_constref descriptiveSchemeID,[out, retval] aafBoolean_t *pIsPresent)
	Returns true if the descriptive scheme ID is present.
HRESULT	AddDescriptiveScheme ([in] aafUID_constref descriptiveSchemeID)
	Appends the given descriptive scheme ID to the list of descriptive schemes found in the file.
HRESULT	RemoveDescriptiveScheme ([in] aafUID_constref descriptiveSchemeID)
	Removes the given descriptive scheme ID from the list of descriptive schemes found in the file.

Detailed Description

The IAAFHeader2 interface provides file-wide information and indexes.

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

When an IAAFHeader2-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 IAAFHeader2 also implement the following interfaces:

IAAFObject

Definition at line 45593 of file AAF.idl.

Member Function Documentation

HRESULT IAAFHeader2::AddDescriptiveScheme ( [in] aafUID_constref descriptiveSchemeID )

Appends the given descriptive scheme ID to the list of descriptive schemes found in the file.

Succeeds if all of the following are true:

the given descriptive scheme ID is not already contained.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

AAFRESULT_INVALID_PARAM

The given descriptive scheme ID is already contained.

Parameters:

descriptiveSchemeID [in] New descriptive scheme ID.

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

Appends the given essence data object to the header.

NOTE! Stub only. Implementation not yet added.

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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::CountDescriptiveSchemes ( [out, retval] aafUInt32 * pCount )

Gets the total number of descriptive schemes present in the file.

Succeeds if all of the following are true:

the pCount pointer is valid.
the DescriptiveSchemes property is present

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

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

pCount arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

pCount [out, retval] Number of descriptive schemes

HRESULT IAAFHeader2::CountEssenceContainers ( [out, retval] aafUInt32 * pCount )

Gets the total number of essence containers present in the file.

Succeeds if all of the following are true:

the pCount pointer is valid.
the EssenceContainers property is present

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

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

pCount arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

pCount [out, retval] Number of essence containers

HRESULT IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::GetDescriptiveSchemes	(	[in] aafUInt32	maxDescriptiveSchemesCount,
		[out, size_is(maxDescriptiveSchemesCount)] aafUID_t *	pDescriptiveSchemeIDs
	)

Gets IDs of descriptive schemes present in the file.

The values are written to the array specified by pDescriptiveSchemeIDs, which is of size maxDescriptiveSchemesCount. The required size may be found by calling CountDescriptiveSchemes().

Succeeds if all of the following are true:

pDescriptiveSchemeIDs is a valid pointer.
maxDescriptiveSchemesCount indicates the array is large enough to hold the data.
the DescriptiveSchemes property is present

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

pDescriptiveSchemeIDs is NULL.

AAFRESULT_SMALLBUF

maxDescriptiveSchemesCount indicates that the array is too small to hold the data.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

maxDescriptiveSchemesCount	[in] The number of elements in the array
pDescriptiveSchemeIDs	[out, size_is(maxDescriptiveSchemesCount)] Array to hold the descriptive scheme IDs

HRESULT IAAFHeader2::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 IAAFHeader2::GetEssenceContainers	(	[in] aafUInt32	maxEssenceContainersCount,
		[out, size_is(maxEssenceContainersCount)] aafUID_t *	pEssenceContainerIDs
	)

Gets IDs of essence containers present in the file.

The values are written to the array specified by pEssenceContainerIDs, which is of size maxEssenceContainersCount. The required size may be found by calling CountEssenceContainers().

Succeeds if all of the following are true:

pEssenceContainerIDs is a valid pointer.
maxEssenceContainersCount indicates the array is large enough to hold the data.
the EssenceContainers property is present

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

pEssenceContainerIDs is NULL.

AAFRESULT_SMALLBUF

maxEssenceContainersCount indicates that the array is too small to hold the data.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

maxEssenceContainersCount	[in] The number of elements in the array
pEssenceContainerIDs	[out, size_is(maxEssenceContainersCount)] Array to hold the essence container IDs

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

Return the File Revision property.

NOTE! Stub only. Implementation not yet added.

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 IAAFHeader2::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 IAAFHeader2::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.

NOTE! Stub only. Implementation not yet added.

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 IAAFHeader2::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 IAAFHeader2::GetLastModified ( [out, retval] aafTimeStamp_t * pTimeStamp )

Return the Last Modified property.

NOTE! Stub only. Implementation not yet added.

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 IAAFHeader2::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 IAAFHeader2::GetOperationalPattern ( [out] aafUID_t * pOperationalPatternID )

This method returns ID of the operational pattern this file complies to.

Succeeds if all of the following are true:

the pOperationalPatternID pointer is valid.
the OperationalPattern property is present

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

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

pOperationalPatternID arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

pOperationalPatternID [out] Operational pattern ID.

HRESULT IAAFHeader2::GetPrimaryMob ( [out, retval] IAAFMob ** pPrimaryMob )

Returns this file's primary mob.

Succeeds if all of the following are true:

the pPrimaryMob pointer is valid.

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

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

pPrimaryMob arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

pPrimaryMob [out, retval] The primary mob

HRESULT IAAFHeader2::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 IAAFHeader2::IsDescriptiveSchemePresent	(	[in, ref] aafUID_constref	descriptiveSchemeID,
		[out, retval] aafBoolean_t *	pIsPresent
	)

Returns true if the descriptive scheme ID is present.

Succeeds if all of the following are true:

the pIsPresent pointer is valid;
the DescriptiveSchemes property is present

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

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

pIsPresent arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

descriptiveSchemeID	[in, ref] Descriptive scheme ID
pIsPresent	[out,retval] Is this descriptive scheme ID present

HRESULT IAAFHeader2::IsEssenceContainerPresent	(	[in, ref] aafUID_constref	essenceContainerID,
		[out, retval] aafBoolean_t *	pIsPresent
	)

Returns true if the essence container is present.

Succeeds if all of the following are true:

the pIsPresent pointer is valid.
the EssenceContainers property is present

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

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

pIsPresent arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

property not present.

Parameters:

essenceContainerID	[in, ref] Essence container ID
pIsPresent	[out,retval] Is this essence container present

HRESULT IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::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 IAAFHeader2::RemoveDescriptiveScheme ( [in] aafUID_constref descriptiveSchemeID )

Removes the given descriptive scheme ID from the list of descriptive schemes found in the file.

Succeeds if all of the following are true:

the DescriptiveSchemes property is present;
the given descriptive scheme ID is present in the list of descriptive schemes found in the file.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_PROP_NOT_PRESENT

property not present.

AAFRESULT_INVALID_PARAM

The given descriptive scheme ID is present in the list of descriptive schemes found in the file.

Parameters:

descriptiveSchemeID [in] Descriptive scheme to remove.

HRESULT IAAFHeader2::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 IAAFHeader2::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

HRESULT IAAFHeader2::SetOperationalPattern ( [in] aafUID_constref operationalPatternID )

Sets operational pattern this file complies to.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NOT_INITIALIZED

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

Parameters:

operationalPatternID [in] Operational pattern ID.

HRESULT IAAFHeader2::SetPrimaryMob ( [in] IAAFMob * pPrimaryMob )

Sets this file's primary mob.

If this method fails, the property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

pPrimaryMob arg is NULL.

AAFRESULT_NOT_INITIALIZED

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

Parameters:

pPrimaryMob [in] The primary mob

HRESULT IAAFHeader2::UpdateEssenceContainers ( )

Ensures that the contents of the EssenceContainers property is in sync with the file's metadata.

If this method succeeds the property will contain IDs of all ContainerDefinitions referenced by source mobs in this file. If the property isn't present it will be created. This method must be called before any other EssenceContainers method can be called.

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

Public Member Functions

Detailed Description

Member Function Documentation