IUccConferenceSessionParticipant.Properties 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 the property collection on this conference participant.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Syntax
'Declaration
ReadOnly Property Properties As IUccReadOnlyPropertyCollection
IUccReadOnlyPropertyCollection Properties { get; }
property IUccReadOnlyPropertyCollection^ Properties {
IUccReadOnlyPropertyCollection^ get ();
}
/** @property */
IUccReadOnlyPropertyCollection get_Properties ()
function get Properties () : IUccReadOnlyPropertyCollection
Property Value
A value of the IUccReadOnlyPropertyCollection** (IUccReadOnlyPropertyCollection, for a .NET application) type. Each element of the resultant property collection is an IUccProperty instance.
Remarks
You can get an individual property from the property collection exposed by Properties. Call get_Property on the collection, passing UCC_CONFERENCE_PARTICIPANT_PROPERTY as an int. The instance of IUccProperty that is returned exposes several properties, only one of which can be set. Read the Value property as an enumeration of UCC_CONFERENCE_PARTICIPANT_PROPERTY.
The following example gets a conference participant's role.
foreach (IUccSessionParticipant p in session.Participants)
{
IUccConferenceSessionParticipant cp = p as IUccConferenceSessionParticipant;
UCC_CONFERENCE_PARTICIPANT_ROLE participantRole = UCC_CONFERENCE_PARTICIPANT_ROLE.UCCCPR_PARTICIPANT;
if (cp.Properties.IsPropertySet((int)UCC_CONFERENCE_PARTICIPANT_PROPERTY.UCCCPPID_ROLE))
{
participantRole = (UCC_CONFERENCE_PARTICIPANT_ROLE)cp.Properties.get_Property((int)UCC_CONFERENCE_PARTICIPANT_PROPERTY.UCCCPPID_ROLE).Value;
}
}
Win32 COM/C++ Syntax
HRESULT get_Properties
(
IUccReadOnlyPropertyCollection** pVal
);
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.
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
IUccConferenceSessionParticipant Interface
IUccConferenceSessionParticipant Members
Microsoft.Office.Interop.UccApi Namespace