IAAFContainerDef Interface Reference

This interface is used with an object representing a particular kind of essence stream factory object, which may be implemented by one or more AAFPluginDescriptors. More...

List of all members.

Public Member Functions
HRESULT	Initialize ([in, ref] aafUID_constref id,[in, string] aafCharacter_constptr pName,[in, string] aafCharacter_constptr pDescription)
	Init all fields of a definition object.
HRESULT	EssenceIsIdentified ([out] aafBoolean_t *pEssenceIsIdentified)
	Tells whether the given plugin is capable of supporting authentication.
HRESULT	SetEssenceIsIdentified ([in] aafBoolean_t EssenceIsIdentified)
	Tells whether the given plugin is capable of supporting authentication.

---

Detailed Description

This interface is used with an object representing a particular kind of essence stream factory object, which may be implemented by one or more AAFPluginDescriptors.

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

IAAFDefObject

• IAAFObject

Definition at line 4278 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFContainerDef::EssenceIsIdentified

(

[out] aafBoolean_t *

pEssenceIsIdentified

)

Tells whether the given plugin is capable of supporting authentication.

The methods for authenticating a plugin are still <tbd>.

Succeeds if all of the following are true:

• the pEssenceIsIdentified pointer is valid.

If this method fails nothing will be written to pEssenceIsIdentified.

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

• pEssenceIsIdentified arg is NULL.

Parameters:

pEssenceIsIdentified

[out] The EssenceIsIdentified

HRESULT IAAFContainerDef::Initialize	(	[in, ref] aafUID_constref	id,
		[in, string] aafCharacter_constptr	pName,
		[in, string] aafCharacter_constptr	pDescription
	)

Init all fields of a definition object.

Parameters:

id	[in, ref] AUID for new DefObject
pName	[in, string] Name for new DefObject
pDescription	[in, string] Description for new DefObject

HRESULT IAAFContainerDef::SetEssenceIsIdentified

(

[in] aafBoolean_t

EssenceIsIdentified

)

Tells whether the given plugin is capable of supporting authentication.

The methods for authenticating a plugin are still <tbd>.

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.

Parameters:

EssenceIsIdentified

[in] The EssenceIsIdentified flag