IMoaDrScoreFrame

Interface ID: IID_IMoaDrScoreFrame
Pointer type: PIMoaDrScoreFrame
Inheritance: IMoaMmPropOwner
Header file: driservc.h

Description

The IMoaDrScoreFrame interface represents a particular frame in a score. You acquire this interface through the IMoaDrScoreAccess::GetFrame() method.

Score frame properties

IMoaDrScoreFrame inherits from the IMoaMmPropOwner interface, providing for access to data through the properties mechanism described in the "Multimedia Services" chapter in the Developer's Guide document. See the "Properties" section for information on the properties defined for objects providing the IMoaDrScoreFrame interface.

Methods

GetProp()
SetProp()

GetProp()

Syntax

GetProp(PIMoaDrScoreFrameThis,

MoaMmSymbolsymbol,
PMoaMmValuepPropValue)

Parameters

This

Pointer to the IMoaDrScoreFrame interface

symbol

MoaMmSymbolThe MoaMmSymbol for the property of interest

pPropValue

PMoaMmValuePointer to a caller-owned MoaMmValue structure to receive the value of the property

Returns

kMoaErr_NoErr	Property exists and value was returned
kMoaErr_BadParam	Invalid pPropValue passed in
kMoaMmErr_PropertyNotFound	Property isn't supported by this class
kMoaMmErr_InternalError	Property exists but couldn't get due to internal error
kMoaMmErr_NoMemForString	Couldn't allocate memory for string value data
kMoaErr_OutOfMem	Couldn't allocate memory for other value data

Description

Obtains the value of the specified score frame property. To get the symbol from a string, use the IMoaMmUtils::StringToSymbol().The caller is responsible for releasing the value with IMoaMmUtils::ValueRelease() when it is no longer needed.

SetProp()

Syntax

SetProp(PIMoaDrScoreFrameThis,

MoaMmSymbolsymbol,
ConstPMoaMmValuepPropValue)

Parameters

This

Pointer to the IMoaDrScoreFrame interface

symbol

MoaMmSymbolThe MoaMmSymbol for the property of interest

pPropValue

ConstPMoaMmValuePointer to a caller-owned ConstPMoaMmValue structure from which to copy the value of the property

Returns

kMoaErr_NoErr	Property exists and value was set
kMoaErr_BadParam	Invalid pPropValue passed in
kMoaMmErr_PropertyNotFound	Property isn't supported by this class
kMoaMmErr_InternalError	Property exists, value ok, but can't set--internal error
kMoaMmErr_NoMemForString	Can't allocate memory for setting string value data
kMoaErr_OutOfMem	Can't allocate memory for setting other value data
kMoaMmErr_IntegerExpected	Type mismatch: integer value expected
kMoaMmErr_SymbolExpected	Type mismatch: symbol value expected
kMoaMmErr_FloatExpected	Type mismatch: float value expected
kMoaMmErr_StringExpected	Type mismatch: string value expected
kMoaMmErr_PointExpected	Type mismatch: point value expected
kMoaMmErr_RectExpected	Type mismatch: rect value expected
kMoaMmErr_ValueTypeMismatch	Type mismatch: other value expected (non-specific)
kMoaDrErr_CastMemberExpected	Type mismatch: CMRef value expected

Description

Sets a score frame property to a new value. To get the symbol from a string, use the IMoaMmUtils::StringToSymbol().The caller continues to maintain ownership of the value passed in, and should release it using IMoaMmUtils::ValueRelease() when it is no longer needed.