IUccReadOnlyPropertyCollection.get_NamedProperty Method

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.

Returns a named property.

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

Syntax

'Declaration
Function get_NamedProperty ( _
    bstrPropertyId As String _
) As UccProperty

UccProperty get_NamedProperty (
    string bstrPropertyId
)

UccProperty^ get_NamedProperty (
    String^ bstrPropertyId
)

UccProperty get_NamedProperty (
    String bstrPropertyId
)

function get_NamedProperty (
    bstrPropertyId : String
) : UccProperty

Parameters

• bstrPropertyId
  A value of the BSTR (string, for a .NET application) type. This specifies the name of a property.

Return Value

A value of the IUccProperty** (IUccProperty, for a .NET application) type. This returns an instance of the property of the given name.

Remarks

A named property uses a string 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 IsNamedPropertySet and passing the string 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_NamedProperty
(
   BSTR bstrPropertyId,
   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.

Example

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

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

   //verify interested property was set
   if (pCollection.IsNamedPropertySet(propertyName))
   {
      //get interested property and fill returnValue with string value of property
      property = pCollection.get_NamedProperty(propertyName);
      returnValue = property.StringValue;

   }
   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

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