CODComponent::GetValue

Gets the value of the given property.

Defined in: OdComponent.cpp

Syntax

BOOL CODComponent::GetValue(const int nPropId, CString& strValue) const

BOOL CODComponent::GetValue(const int nPropId, int& nValue) const

BOOL CODComponent::GetValue(const int nPropId, UINT& nValue) const

BOOL CODComponent::GetValue(const int nPropId, DWORD& dwValue) const

BOOL CODComponent::GetValue(const int nPropId, float& fValue) const

Return Value

TRUE if the property identifier is found in the component and the value successfully assigned to the output parameter. FALSE if the component does not contain the specified property.

Parameters

nPropId

ID of property to retrieve.

strValue

Variable to assign return value to.

nValue

Variable to assign return value to.

nValue

Variable to assign return value to.

dwValue

Variable to assign return value to.

fValue

Variable to assign return value to.

Comments

This function will throw a  CODPropertyConversionException exception if the data type of the argument passed in is not compatible with the given property identifier.