![]() |
v2.30
|
|
Represents a property. More...
Public Member Functions | |
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 | GetDoubleValue ([out, retval] double *pValue) |
Returns the property value as a double . 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 | GetStringValue ([out, retval] BSTR *pValue) |
Returns the property value as a string . More... | |
HRESULT | GetVolumeValue ([in] enum VolumeUnit unit, [out, retval] double *pValue) |
Returns the property value as a volume. More... | |
HRESULT | HasValue ([out, retval] VARIANT_BOOL *pResult) |
Indicates if the property has a value. More... | |
HRESULT | ResetValue () |
Resets the value of the property. Marks the property as unset, so that subsequent calls to HasValue() return FALSE. | |
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 | SetDoubleValue ([in] double value_) |
Sets the property value as a double . 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 | SetStringValue ([in] BSTR value_) |
Sets the property value as a string . More... | |
HRESULT | SetVolumeValue ([in] double value_, [in] enum VolumeUnit unit) |
Sets the property value as a volume. More... | |
Properties | |
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. | |
PropertyType | Type [get] |
The type of property. | |
Represents a property.
A Property contains a value of one of the following types: double
or string
. This interface can be obtained through IPropertyContainer.
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.
[in] | unit | Unit of measure for the angle. |
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.
[in] | unit | Unit of measure for the area. |
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.
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.
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.
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.
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.
[in] | unit | Unit of measure for the length. |
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.
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
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.
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.
[in] | unit | Unit of measure for the volume. |
HRESULT IProperty::HasValue | ( | [out, retval] VARIANT_BOOL * | pResult | ) |
Indicates if the property has a value.
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.
[in] | value_ | New value of the property. |
[in] | unit | Unit of measure for the angle. |
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.
[in] | value_ | New value of the property. |
[in] | unit | Unit of measure for the area. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
[in] | unit | Unit of measure for the length. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
[in] | unit | Unit of measure for the mass. |
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.
[in] | value_ | New value of the property. |
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.
[in] | value_ | New value of the property. |
[in] | unit | Unit of measure for the volume. |