IAAFCommentMarker Interface Reference

The IAAFCommentMarker interface is implemented by objects which represent a user comment associated with a point in time. More...

List of all members.

Public Member Functions
HRESULT	GetAnnotation ([out, retval] IAAFSourceReference **ppResult)
	This method will get the annotation for this comment marker and place an interface for it into the **ppResult argument.
HRESULT	SetAnnotation ([in] IAAFSourceReference *pAnnotation)
	This method will set the Annotation for this comment marker.

---

Detailed Description

The IAAFCommentMarker interface is implemented by objects which represent a user comment associated with a point in time.

A CommentMarker may have a SourceReference that specifies a text or audio annotation.

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.

AAFRESULT_NOT_INITIALIZED

• This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFMobSlot is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface.

Objects that implement IAAFCommentMarker also implement the following interfaces:

• IAAFEvent
• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 3568 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFCommentMarker::GetAnnotation

(

[out, retval] IAAFSourceReference **

ppResult

)

This method will get the annotation for this comment marker and place an interface for it into the **ppResult 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 arg is NULL.

Parameters:

ppResult

[out,retval] Annotation property value

HRESULT IAAFCommentMarker::SetAnnotation

(

[in] IAAFSourceReference *

pAnnotation

)

This method will set the Annotation for this comment marker.

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

Parameters:

pAnnotation

[in] Annotation property value