![]() |
v2.41
|
|
Represents a property. More...
Public Member Functions | |
| HRESULT | GetAngleValue ([in] enum AngleUnit unit, [out, retval] double *pValue) |
| Returns the property value as an angle. | |
| HRESULT | GetAreaValue ([in] enum AreaUnit unit, [out, retval] double *pValue) |
| Returns the property value as an area. | |
| HRESULT | GetBooleanValue ([out, retval] VARIANT_BOOL *pValue) |
| Returns the property value as a boolean. | |
| HRESULT | GetDoubleValue ([out, retval] double *pValue) |
Returns the property value as a double. | |
| HRESULT | GetEnumerationValue ([out, retval] BSTR *pValue) |
| Returns the property value as an enumeration. | |
| HRESULT | GetIntegerValue ([out, retval] int *pValue) |
| Returns the property value as an integer. | |
| HRESULT | GetLengthValue ([in] enum LengthUnit unit, [out, retval] double *pValue) |
| Returns the property value as a length. | |
| HRESULT | GetLogicalValue ([out, retval] enum Logical *pValue) |
| Returns the property value as a tree-state logical value. | |
| HRESULT | GetMassValue ([in] enum MassUnit unit, [out, retval] double *pValue) |
| Returns the property value as a mass. | |
| HRESULT | GetStringValue ([out, retval] BSTR *pValue) |
Returns the property value as a string. | |
| HRESULT | GetVolumeValue ([in] enum VolumeUnit unit, [out, retval] double *pValue) |
| Returns the property value as a volume. | |
| HRESULT | HasValue ([out, retval] VARIANT_BOOL *pResult) |
| Indicates if the property has a value. | |
| 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. | |
| HRESULT | SetAreaValue ([in] double value_, [in] enum AreaUnit unit) |
| Sets the property value as an area. | |
| HRESULT | SetBooleanValue ([in] VARIANT_BOOL value_) |
| Sets the property value as a boolean. | |
| HRESULT | SetDoubleValue ([in] double value_) |
Sets the property value as a double. | |
| HRESULT | SetEnumerationValue ([in] BSTR value_) |
| Sets the property value as an enumeration. | |
| HRESULT | SetIntegerValue ([in] int value_) |
| Sets the property value as an integer. | |
| HRESULT | SetLengthValue ([in] double value_, [in] enum LengthUnit unit) |
| Sets the property value as a length. | |
| HRESULT | SetLogicalValue ([in] enum Logical value_) |
| Sets the property value as a tree-state logical value. | |
| HRESULT | SetMassValue ([in] double value_, [in] enum MassUnit unit) |
| Sets the property value as a mass. | |
| HRESULT | SetStringValue ([in] BSTR value_) |
Sets the property value as a string. | |
| HRESULT | SetVolumeValue ([in] double value_, [in] enum VolumeUnit unit) |
| Sets the property value as a volume. | |
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.
This interface can be obtained through IPropertyContainer.
| HRESULT 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 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 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 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 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 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 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 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 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 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 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 HasValue | ( | [out, retval] VARIANT_BOOL * | pResult | ) |
Indicates if the property has a value.
| HRESULT 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 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 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 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 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 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 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 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 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 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 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. |