Share via

IUccProperty.Name Property

  • Article

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 the name of this property instance.

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

Syntax

'Declaration
ReadOnly Property Name As String

string Name { get; }

property String^ Name {
    String^ get ();
}

/** @property */
String get_Name ()

function get Name () : String

Property Value

A value of the BSTR* (string, for a .NET application) type. This returns the name of the property.

Remarks

The Name property of an IUccProperty instance is filled when the property has been created with a call to AddNamedProperty.

Properties created by calling AddProperty contain an un-initialized Name property. Accessing an un-initialized Name property raises a UCC_E_NOT_EXIST COM exception. IUccProperty instances created by the Unified Communications platform are identified by their Id properties. The Name property is always un-initialized.

Win32 COM/C++ Syntax

HRESULT get_Name
(
   BSTR* bstrPropertyName
);

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 gets an IUccProperty instance from a property collection using the passed numeric index. The Id property is referenced within a try/catch block. If a COM exception is raised, the Name of the property instance is returned instead.

public string CollectionPropertyItemName(IUccPropertyCollection pPropertyCollection, int pIndex)
{
   string returnValue = string.Empty;
   if (pIndex < 1 || pIndex > pPropertyCollection.Count)
   {
      throw new ArgumentOutOfRangeException();
   }
   IUccProperty p = pPropertyCollection[pIndex] as IUccProperty;
   try
   {
      returnValue = p.Id.ToString();
   }
   catch (COMException e)
   {
      Console.WriteLine(e.ErrorCode.ToString());
      returnValue = p.Name;
   }
   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