The IAAFEvent interface is implemented by objects which represent a text comment, a trigger, or an area in the image that has an associated interactive action. More...

Public Member Functions
HRESULT	GetPosition ([out, retval] aafPosition_t *pPosition)
	This method will return the Position of this event.
HRESULT	SetPosition ([in] aafPosition_t Position)
	This method will set the Position of this event.
HRESULT	SetComment ([in, string] aafCharacter_constptr pComment)
	Sets specifies the purpose of the event.
HRESULT	GetComment ([out, string, size_is(bufSize)] aafCharacter *pComment,[in] aafUInt32 bufSize)
	Gets specifies the purpose of the event.
HRESULT	GetCommentBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetComment().

Detailed Description

The IAAFEvent interface is implemented by objects which represent a text comment, a trigger, or an area in the image that has an associated interactive action.

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

Definition at line 9168 of file AAF.idl.

Member Function Documentation

HRESULT IAAFEvent::GetComment	(	[out, string, size_is(bufSize)] aafCharacter *	pComment,
		[in] aafUInt32	bufSize
	)

Gets specifies the purpose of the event.

Writes the Comment property, with a trailing null character, into the pComment buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the Comment property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetCommentBufLen() to determine the required buffer size.

If this method fails nothing will be written to pComment.

Succeeds if:

The pComment pointer is valid.
bufSize indicates that the buffer is large enough to hold Comment.

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

pComment arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold Comment.

Parameters:

pComment	[out, string, size_is(bufSize)] buffer into which Comment is to be written
bufSize	[in] size of *pComment buffer in bytes

HRESULT IAAFEvent::GetCommentBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetComment().

Succeeds if:

The pBufSize 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_NULL_PARAM

pBufSize arg is NULL.

Parameters:

pBufSize [out] size of required buffer, in bytes

HRESULT IAAFEvent::GetPosition ( [out, retval] aafPosition_t * pPosition )

This method will return the Position of this event.

Succeeds if all of the following are true:

the pPosition 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

pPosition arg is NULL.

Parameters:

pPosition [out,retval] Position property value

HRESULT IAAFEvent::SetComment ( [in, string] aafCharacter_constptr pComment )

Sets specifies the purpose of the event.

Set the Comment property to the value specified in pComment. A copy is made of the data so the caller retains ownership of the *pComment buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space.

Succeeds if all of the following are true:

the pComment pointer is valid.

If this method fails the Comment property will not 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

pComment arg is NULL.

Parameters:

pComment [in, string] buffer from which Comment is to be read

HRESULT IAAFEvent::SetPosition ( [in] aafPosition_t Position )

This method will set the Position of this event.

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:

Position [in] Position property value

Public Member Functions

Detailed Description

Member Function Documentation