IUccReadOnlyPropertyCollection.IsPropertySet 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.

Determines whether a property has its value assigned.

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

Syntax

'Declaration
Function IsPropertySet ( _
    lPropertyId As Integer _
) As Boolean

bool IsPropertySet (
    int lPropertyId
)

bool IsPropertySet (
    int lPropertyId
)

boolean IsPropertySet (
    int lPropertyId
)

function IsPropertySet (
    lPropertyId : int
) : boolean

Parameters

• lPropertyId
  A value of the LONG (int, for a .NET application) type. This specifies the ID of the property of interest.

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE if the property has its value set and FALSE if not.

Remarks

Accessing an uninitialized property in a read-only collection raises a COM exception. IsPropertySet enables an application to determine whether a property has been initialized before attempting to access the property.

Win32 COM/C++ Syntax

HRESULT IsPropertySet
(
   LONG lPropertyId,
   VARIANT_BOOL* pbSet
);

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 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;
}

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