CATPLMComponentInterfaces Interface CATIPLMNavRepReference

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIPLMNavRepReference

Interface to navigate on a Representation Reference.

Method Index

o GetContentKind(CATPLMAuthoringStreamDescriptorKind&): Retrieves the kind of authoring Stream Descriptor.
o IsOnceInstantiable(): Check if a representation reference is only instantiable once.
o ListInstances(CATListPtrCATIPLMNavRepInstance&): Retrieves the list of Representation Instances which are instance of the Representation Reference.
o RetrieveApplicativeContainer(CATUnicodeString&,IID&,void**): Retrieve a given container of the RepReference.

Methods

o GetContentKind

public virtual GetContentKind( oContentKind)

Retrieves the kind of authoring Stream Descriptor.

Parameters:

oContentKind: The authoring Content kind.

Returns:

HRESULT
Legal values:

S_OK: The Kind is successfully returned.
E_UNEXPECTED: There is an unexpected failure.

o IsOnceInstantiable

public virtual IsOnceInstantiable(

)

Check if a representation reference is only instantiable once.

Returns:

HRESULT
Legal values:

S_OK: The representation reference is instantiable only once.
S_FALSE: The representation reference is not instantiable only once.
E_NOTIMPL: No answer can be provided. The behavior is not implemented.
E_UNEXPECTED: There is an unexpected failure.

o ListInstances

public virtual ListInstances( ioRepInstancesList)

Retrieves the list of Representation Instances which are instance of the Representation Reference.

Parameters:

ioRepInstancesList

The list of Representation Instances. Warning this list is cleaned before treatment.
Legal values:

Empty: The Representation Reference is not instanciated.
Filled: The Representation References is instanciated (in this case the order is not guaranteed).

Returns:

HRESULT
Legal values:

S_OK: The list (Empty or Filled) is successfully returned.
E_FAIL: The RepReference is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o RetrieveApplicativeContainer

public virtual RetrieveApplicativeContainer(	const	`iIdentifier`,
	const	`iIID`,
		`oApplicativeContainer`)

Retrieve a given container of the RepReference.

Parameters:

iIdentifier: The iIdentifier of the Container we are looking for.
iIID: The IID of the interface.
oApplicativeContainer: [out, CATBaseUnknown#Release] The retrieved container.

Returns:

HRESULT
Legal values:

S_OK: The container is successfully returned.
E_NOINTERFACE: Interface corresponding to the IID, is not implmented on the container.
E_FAIL: The RepReference is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

This object is included in the file: CATIPLMNavRepReference.h
If needed, your Imakefile.mk should include the module: CATPLMComponentInterfaces