v2.4
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...
 

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

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

Returns the property value as a double.

It is an error to call this method on a string-typed property.

Returns
Value of the property.
HRESULT IProperty::GetStringValue ( [out, retval] BSTR *  pValue)

Returns the property value as a string.

It is an error to call this method on a double-typed property.

Returns
Value of the property.
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.
HRESULT IProperty::SetDoubleValue ( [in] double  value_)

Sets the property value as a double.

It is an error to call this method on a string-typed property.

Parameters
[in]value_New value of the property.
HRESULT IProperty::SetStringValue ( [in] BSTR  value_)

Sets the property value as a string.

It is an error to call this method on a double-typed property.

Parameters
[in]value_New value of the property.