IAppHostPropertySchema::IsCombinedKey Property

Determines whether a property is part of a multiple-attribute key for a collection.

Syntax

HRESULT get_IsCombinedKey(  
   [out,  
   retval] VARIANT_BOOL* pfIsCombinedKey  
);  

Parameters

pfIsCombinedKey
A pointer to a VARIANT_BOOL. VARIANT_TRUE if the property is part of a multiple-attribute key; otherwise, VARIANT_FALSE.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Remarks

The binding element is an example of a combined key. In the following example, the binding element contains protocol and bindingInformation attributes that are part of a combined key.

<element name="bindings">

<collection addElement="binding" clearElement="clear">

<attribute name="protocol" type="string" required="true" isCombinedKey="true" validationType="nonEmptyString" />

<attribute name="bindingInformation" type="string" required="true" isCombinedKey="true" validationType="nonEmptyString" />

</collection>

</element>

The bindings element can contain any number of elements that have the same protocol attribute. However, the bindings element cannot contain more than one binding element that has the same protocol and bindingInformation attributes.

Requirements

See Also

IAppHostPropertySchema Interface
IAppHostPropertySchema::IsUniqueKey Property