AAFA Developer Support

Main Page | Class List | File List | Class Members | File Members

IAAFContainerDef Interface Reference

List of all members.

Detailed Description

Objects that implement IAAFContainerDef also implement the following interfaces: - IAAFDefObject - IAAFObject.

Definition at line 1926 of file AAF.idl.

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.


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

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 DeObject
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

Parameters:
EssenceIsIdentified [in] The EssenceIsIdentified flag


Generated on Thu Feb 17 09:34:14 2005 for AAF COM API by doxygen 1.4.1