IUccReadOnlyPropertyCollection.get_Property Method

UccProperty get_Property (
	int lPropertyId
)

UccProperty get_Property (
	int lPropertyId
)

function get_Property (
	lPropertyId : int
) : UccProperty

Parameters

lPropertyId

A value of the LONG* (int, for a .NET application) type. This specifies the property ID. IDs of the API supported properties are defined by appropriate UCC_*_PROPERTY enumeration types.

Return Value

A property uses an integer as the property ID. Attempting to get a property out of a read-only property collection where that property has not been set in the collection yields a COM error. Before attempting to access a property, the existence of the property should be verified. Calling into IsPropertySet and passing the integer Id of interest returns a boolean value. A true value indicates the property has been set and can be retrieved.

Win32 COM/C++ Syntax

HRESULT get_Property
(
   LONG* lPropertyId,
   IUccProperty** ppProperty
);

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 UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

The following example accepts a read-only property collection and a integer representing the Id of the property of interest. The existence of the property is tested and if exists, the string value of the property is returned.

private string GetPropertyStringValue(
   IUccReadOnlyPropertyCollection pCollection,
   int propertyId)
{
   //initialize return value
   string returnValue = string.Empty;
   IUccProperty property;

   //verify interested property was set
   if (pCollection.IsPropertySet(propertyId))
   {
      //get interested property and fill returnValue with string value of property
      property = pCollection.get_Property(propertyId);
      returnValue = property.StringValue;
   }
   return returnValue;
}
 

Development Platforms

Target Platforms