v2.23
IProperty Interface Reference

Represents a property. More...

Inheritance diagram for IProperty:

Public Member Functions

HRESULT SetDoubleValue ([in] double value_)
 Sets the property value as a double. More...
 
HRESULT SetStringValue ([in] BSTR value_)
 Sets the property value as a string. More...
 
HRESULT GetDoubleValue ([out, retval] double *pValue)
 Returns the property value as a double. More...
 
HRESULT GetStringValue ([out, retval] BSTR *pValue)
 Returns the property value as a string. More...
 
HRESULT ResetValue ()
 Resets the value of the property. Marks the property as unset, so that subsequent calls to HasValue() return FALSE.
 
HRESULT HasValue ([out, retval] VARIANT_BOOL *pResult)
 Indicates if the property has a value. More...
 
HRESULT SetAngleValue ([in] double value_, [in] enum AngleUnit unit)
 Sets the property value as an angle. More...
 
HRESULT SetAreaValue ([in] double value_, [in] enum AreaUnit unit)
 Sets the property value as an area. More...
 
HRESULT SetBooleanValue ([in] VARIANT_BOOL value_)
 Sets the property value as a boolean. More...
 
HRESULT SetEnumerationValue ([in] BSTR value_)
 Sets the property value as an enumeration. More...
 
HRESULT SetIntegerValue ([in] int value_)
 Sets the property value as an integer. More...
 
HRESULT SetLengthValue ([in] double value_, [in] enum LengthUnit unit)
 Sets the property value as a length. More...
 
HRESULT SetLogicalValue ([in] enum Logical value_)
 Sets the property value as a tree-state logical value. More...
 
HRESULT SetMassValue ([in] double value_, [in] enum MassUnit unit)
 Sets the property value as a mass. More...
 
HRESULT SetVolumeValue ([in] double value_, [in] enum VolumeUnit unit)
 Sets the property value as a volume. More...
 
HRESULT GetAngleValue ([in] enum AngleUnit unit, [out, retval] double *pValue)
 Returns the property value as an angle. More...
 
HRESULT GetAreaValue ([in] enum AreaUnit unit, [out, retval] double *pValue)
 Returns the property value as an area. More...
 
HRESULT GetBooleanValue ([out, retval] VARIANT_BOOL *pValue)
 Returns the property value as a boolean. More...
 
HRESULT GetEnumerationValue ([out, retval] BSTR *pValue)
 Returns the property value as an enumeration. More...
 
HRESULT GetIntegerValue ([out, retval] int *pValue)
 Returns the property value as an integer. More...
 
HRESULT GetLengthValue ([in] enum LengthUnit unit, [out, retval] double *pValue)
 Returns the property value as a length. More...
 
HRESULT GetLogicalValue ([out, retval] enum Logical *pValue)
 Returns the property value as a tree-state logical value. More...
 
HRESULT GetMassValue ([in] enum MassUnit unit, [out, retval] double *pValue)
 Returns the property value as a mass. More...
 
HRESULT GetVolumeValue ([in] enum VolumeUnit unit, [out, retval] double *pValue)
 Returns the property value as a volume. More...
 

Properties

PropertyType Type [get]
 The type of property.
 
GUID Id [get]
 The unique identifier of the property.
 
BSTR IdS [get]
 The unique identifier of the property as a string.
 
BSTR Name [get]
 The name of the property.
 

Detailed Description

Represents a property.

A Property contains a value of one of the following types: double or string. This interface can be obtained through IPropertyContainer.

Member Function Documentation

◆ GetAngleValue()

HRESULT IProperty::GetAngleValue ( [in] enum AngleUnit  unit,
[out, retval] double *  pValue 
)

Returns the property value as an angle.

It is an error to call this method on a property of type other than PropertyType_Angle.

Parameters
[in]unitUnit of measure for the angle.
Returns
Value of the property.

◆ GetAreaValue()

HRESULT IProperty::GetAreaValue ( [in] enum AreaUnit  unit,
[out, retval] double *  pValue 
)

Returns the property value as an area.

It is an error to call this method on a property of type other than PropertyType_Area.

Parameters
[in]unitUnit of measure for the area.
Returns
Value of the property.

◆ GetBooleanValue()

HRESULT IProperty::GetBooleanValue ( [out, retval] VARIANT_BOOL *  pValue)

Returns the property value as a boolean.

It is an error to call this method on a property of type other than PropertyType_Boolean.

Returns
Value of the property.

◆ GetDoubleValue()

HRESULT IProperty::GetDoubleValue ( [out, retval] double *  pValue)

Returns the property value as a double.

It is an error to call this method on a property of type other than PropertyType_Double.

Returns
Value of the property.

◆ GetEnumerationValue()

HRESULT IProperty::GetEnumerationValue ( [out, retval] BSTR *  pValue)

Returns the property value as an enumeration.

It is an error to call this method on a property of type other than PropertyType_Enumeration.

Returns
Value of the property.

◆ GetIntegerValue()

HRESULT IProperty::GetIntegerValue ( [out, retval] int *  pValue)

Returns the property value as an integer.

It is an error to call this method on a property of type other than PropertyType_Integer.

Returns
Value of the property.

◆ GetLengthValue()

HRESULT IProperty::GetLengthValue ( [in] enum LengthUnit  unit,
[out, retval] double *  pValue 
)

Returns the property value as a length.

It is an error to call this method on a property of type other than PropertyType_Length.

Parameters
[in]unitUnit of measure for the length.
Returns
Value of the property.

◆ GetLogicalValue()

HRESULT IProperty::GetLogicalValue ( [out, retval] enum Logical pValue)

Returns the property value as a tree-state logical value.

It is an error to call this method on a property of type other than PropertyType_Logical.

Returns
Value of the property.

◆ GetMassValue()

HRESULT IProperty::GetMassValue ( [in] enum MassUnit  unit,
[out, retval] double *  pValue 
)

Returns the property value as a mass.

It is an error to call this method on a property of type other than PropertyType_Mass. [in] enum MassUnit unit

Returns
Value of the property.

◆ GetStringValue()

HRESULT IProperty::GetStringValue ( [out, retval] BSTR *  pValue)

Returns the property value as a string.

It is an error to call this method on a property of type other than PropertyType_String.

Returns
Value of the property.

◆ GetVolumeValue()

HRESULT IProperty::GetVolumeValue ( [in] enum VolumeUnit  unit,
[out, retval] double *  pValue 
)

Returns the property value as a volume.

It is an error to call this method on a property of type other than PropertyType_Volume.

Parameters
[in]unitUnit of measure for the volume.
Returns
Value of the property.

◆ HasValue()

HRESULT IProperty::HasValue ( [out, retval] VARIANT_BOOL *  pResult)

Indicates if the property has a value.

Returns
TRUE if the property has a value; otherwise returns FALSE.

◆ SetAngleValue()

HRESULT IProperty::SetAngleValue ( [in] double  value_,
[in] enum AngleUnit  unit 
)

Sets the property value as an angle.

It is an error to call this method on a property of type other than PropertyType_Angle.

Parameters
[in]value_New value of the property.
[in]unitUnit of measure for the angle.

◆ SetAreaValue()

HRESULT IProperty::SetAreaValue ( [in] double  value_,
[in] enum AreaUnit  unit 
)

Sets the property value as an area.

It is an error to call this method on a property of type other than PropertyType_Area.

Parameters
[in]value_New value of the property.
[in]unitUnit of measure for the area.

◆ SetBooleanValue()

HRESULT IProperty::SetBooleanValue ( [in] VARIANT_BOOL  value_)

Sets the property value as a boolean.

It is an error to call this method on a property of type other than PropertyType_Boolean.

Parameters
[in]value_New value of the property.

◆ SetDoubleValue()

HRESULT IProperty::SetDoubleValue ( [in] double  value_)

Sets the property value as a double.

It is an error to call this method on a property of type other than PropertyType_Double.

Parameters
[in]value_New value of the property.

◆ SetEnumerationValue()

HRESULT IProperty::SetEnumerationValue ( [in] BSTR  value_)

Sets the property value as an enumeration.

It is an error to call this method on a property of type other than PropertyType_Enumeration.

Parameters
[in]value_New value of the property.

◆ SetIntegerValue()

HRESULT IProperty::SetIntegerValue ( [in] int  value_)

Sets the property value as an integer.

It is an error to call this method on a property of type other than PropertyType_Integer.

Parameters
[in]value_New value of the property.

◆ SetLengthValue()

HRESULT IProperty::SetLengthValue ( [in] double  value_,
[in] enum LengthUnit  unit 
)

Sets the property value as a length.

It is an error to call this method on a property of type other than PropertyType_Length.

Parameters
[in]value_New value of the property.
[in]unitUnit of measure for the length.

◆ SetLogicalValue()

HRESULT IProperty::SetLogicalValue ( [in] enum Logical  value_)

Sets the property value as a tree-state logical value.

It is an error to call this method on a property of type other than PropertyType_Logical.

Parameters
[in]value_New value of the property.

◆ SetMassValue()

HRESULT IProperty::SetMassValue ( [in] double  value_,
[in] enum MassUnit  unit 
)

Sets the property value as a mass.

It is an error to call this method on a property of type other than PropertyType_Mass.

Parameters
[in]value_New value of the property.
[in]unitUnit of measure for the mass.

◆ SetStringValue()

HRESULT IProperty::SetStringValue ( [in] BSTR  value_)

Sets the property value as a string.

It is an error to call this method on a property of type other than PropertyType_String.

Parameters
[in]value_New value of the property.

◆ SetVolumeValue()

HRESULT IProperty::SetVolumeValue ( [in] double  value_,
[in] enum VolumeUnit  unit 
)

Sets the property value as a volume.

It is an error to call this method on a property of type other than PropertyType_Volume.

Parameters
[in]value_New value of the property.
[in]unitUnit of measure for the volume.