UCC_PROPERTY_MASK Enumeration
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.
Enumerates the property ID masks used to determine metadata of a property value of a given property ID.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Syntax
'Declaration
Public Enumeration UCC_PROPERTY_MASK
public enum UCC_PROPERTY_MASK
public enum class UCC_PROPERTY_MASK
public enum UCC_PROPERTY_MASK
public enum UCC_PROPERTY_MASK
Members
| Member name | Description |
|---|---|
| UCCPM_ACCESSIBILITY | Used to mask the accessibility of the property. The property is read-only if this bit is set. It is a read-write property if this bit is not set. This points to the one bit below UCCPM_CLASS of a property ID. |
| UCCPM_CLASS | Used to mask the UCC API-defined COM type to which the property is applied. This points to the 12 bits below UCCPM_RESERVED of a property ID. |
| UCCPM_ID | Used to mask the ordering of the property identifier. This points to the lowest 10 bits of a property ID. |
| UCCPM_RESERVED | Used to mask the reserved field of a 32-bit property identifier. This represents the highest four bits of a property ID. |
| UCCPM_TYPE | Used to mask the data type of the property value. This points to the five bits below UCCPM_ACCESSIBILITY of a property ID. |
Remarks
In UCC API a property is a name-value pair. The name is also known as the property ID and is defined by a member of an appropriate enumeration type. The value can be a string or number as well as an object or other data types. Such enumeration types contains such phrases as PROPERTY and CONTEXT. For example, the UCC_PLATFORM_CONTEXT enumeration type defines two properties that an application can set on an instance of the UCC API application framework. The first one is identified by the UCCPC_DISABLE_MEDIA field and the second one by the UCCPC_SUPPORT_HID field. They are 32-bit integers and contains such information as the ID and data type of a property as well as the accessibility and applicable class of the property. This information is encoded in such a way that the ID is stored in lowest 10 bits (bit 0 to bit 9) of the property name. The data type is stored in the next 5 bits (bit 10 to bit 14). The accessibility information is stored in the 16th bit, and the information about the applicable class is stored the next 12 bits (bit 16 to bit 27). The remaining bits (27–31) are reserved. An application can use this enumeration type to decode the metadata of a property by performing a bit-wise AND operation of the property name against one of the fields defined in this enumeration type. In the previous example, the data type of the UCC_PLATFORM_CONTEXT.UCCPC_SUPPORT_HID property can be determined by comparing the result of UCCPC_SUPPORT_HID and UCC_PROPERTY_MASK.UCCPM_TYPE against a UCC_PROPERTY_TYPE value. The bit-wise AND (&) operation should yield a UCC_PROPERTY_TYPE.UCCPT_BOOLEAN value.
Win32 COM/C++ Syntax
typedef enum UCC_PROPERTY_MASK
{
UCCPM_RESERVED = 0xF0000000,
UCCPM_CLASS = 0x0FFF0000,
UCCPM_ACCESSIBILITY = 0x00008000,
UCCPM_TYPE = 0x00007C00,
UCCPM_ID = 0x000003FF
};
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