IUccProperty.Value Property

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets and sets the value of the property.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Property Value As Object

Object Value { get; set; }

property Object^ Value {
    Object^ get ();
    void set (Object^ value);
}

/** @property */
Object get_Value ()

/** @property */
void set_Value (Object value)

function get Value () : Object

function set Value (value : Object)

Property Value

A value of the VARIANT* (object, for a .NET application) type. This returns the property value.

Remarks

The value property returns an object instance containing the value of the property regardless of the ultimate type. The object returned is the object set in the IUccProperty instance at the time it is created with either a call to AddProperty or AddNamedProperty.

Win32 COM/C++ Syntax

HRESULT get_Value
(
   VARIANT* pvPropertyValue
);
HRESULT put_Value
(
   VARIANT pvPropertyValue
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the Unified Communications Client API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The following example returns the original value of a given property by reading the Value property of the IUccProperty instance provided by a call to get_NamedProperty

public object GetPropertyValue(IUccPropertyCollection pCollection, string pPropertyName)
{
   object returnValue = null;
   if (pCollection.IsNamedPropertySet(pPropertyName))
   {
         returnValue = pCollection.get_NamedProperty(pPropertyName).Value;
   }
   return returnValue;
}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccProperty Interface
IUccProperty Members
Microsoft.Office.Interop.UccApi Namespace