The IAAFParameter interface is implemented by objects that specify an Instantiation of an operation parameter. More...

Public Member Functions
HRESULT	GetParameterDefinition ([out, retval] IAAFParameterDef **ppParmDef)
	Places the parameter definition of the operation parameter into the *ppParmDef argument.
HRESULT	GetTypeDefinition ([out, retval] IAAFTypeDef **ppTypeDef)
	Places the IAAFTypeDefinition of the data value inside this parameter into the *ppTypeDef argument.

Detailed Description

The IAAFParameter interface is implemented by objects that specify an Instantiation of an operation parameter.

It is an abstract class, so you should use AAFConstantValue or AAFVaryingValue.

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

IAAFObject

Definition at line 19290 of file AAF.idl.

Member Function Documentation

HRESULT IAAFParameter::GetParameterDefinition ( [out, retval] IAAFParameterDef ** ppParmDef )

Places the parameter definition of the operation parameter into the *ppParmDef argument.

The length of an operation parameter is in the same edit units and has the same value as the IAAFOperationGroup enclosing this parameter.

Succeeds if all of the following are true:

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

ppParmDef is null.

Parameters:

ppParmDef [out,retval] New parameter definition

HRESULT IAAFParameter::GetTypeDefinition ( [out, retval] IAAFTypeDef ** ppTypeDef )

Places the IAAFTypeDefinition of the data value inside this parameter into the *ppTypeDef argument.

The data value is the value of the parameter. It is often an integer or rational, and may change over time. An example of a value would be the "level" parameter of a video dissolve, which has control points with a value of zero (0 percent B material) at the start, to one (100 percent B material) at the end. The data value will actually be stored in either AAFConstantValue or one of the AAFControlPoints inside of an AAFVaryingValue.

The definition is stored in the base class because it should be constant for all control points inside of a varying value.