IAppHostPropertySchema::IsCombinedKey Property

Article
06/14/2022

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.

Value	Description
S_OK	Indicates that the operation was successful.

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

Type	Description
Client	- IIS 7.0 on Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10
Server	- IIS 7.0 on Windows Server 2008 - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016
Product	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
Header	Ahadmin.h