Skip to content

iapphostelement-collection-property.md

Latest commit

 

History

History
88 lines (74 loc) · 4.8 KB

iapphostelement-collection-property.md

File metadata and controls

88 lines (74 loc) · 4.8 KB
title IAppHostElement::Collection Property
description The IAppHostElementCollection property represents a collection of elements that belongs to a collection.
ms.date 10/07/2016
ms.assetid 520835fe-cff6-7dbd-5154-a827a983b734

IAppHostElement::Collection Property

Represents a collection of elements that belongs to a collection.

Syntax

HRESULT get_Collection(  
   [out,  
   retval] IAppHostElementCollection** ppCollection  
);

Parameters

ppCollection
A pointer to a pointer for an IAppHostElementCollection interface.

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

A child element collection that is represented in the IAppHostElement::ChildElements property differs from a nested element collection that is represented in the IAppHostElement::Collection property. Both collections contain pointers to IAppHostElement objects. However, you should use the IAppHostElement::ChildElements property when you query the configuration for unique child elements, such as the system.webServer/asp configuration section. In the following configuration example, the <cache/> element is a child elements of the system.webServer/asp configuration section.

<system.webServer>  
    <asp>  
        <cache diskTemplateCacheDirectory="%SystemDrive%\inetpub\temp\ASP Compiled Templates" />  
    </asp>  
</system.webServer>

You should use the IAppHostElement::Collection property when you query the configuration for child elements that contain a unique key or a multi-attribute key, such as the system.webServer/sites configuration section. In the following configuration example, the <site/> elements are collection elements and the <applicationDefaults/> element is a child element of the system.applicationHost/sites configuration section.

<system.applicationHost>  
    <sites>  
        <site name="Default Web Site" id="1">  
            <application path="/">  
                <virtualDirectory path="/"   
                                  physicalPath="%SystemDrive%\inetpub\wwwroot" />  
            </application>  
            <bindings>  
                <binding protocol="http" bindingInformation="*:80:" />  
            </bindings>  
        </site>  
        <site name="Microsoft.com" id="35">  
            <bindings>  
                <binding protocol="http"   
                         bindingInformation="*:80:microsoft.com" />  
            </bindings>  
        </site>  
        <siteDefaults>  
            <logFile customLogPluginClsid="{FF160663-DE82-11CF-BC0A-00AA006111E0}"   
                     directory="%SystemDrive%\inetpub\logs\LogFiles" />  
            <traceFailedRequestsLogging   
                     directory="%SystemDrive%\inetpub\logs\FailedReqLogFiles" />  
        </siteDefaults>  
        <applicationDefaults applicationPool="DefaultAppPool" />  
        <virtualDirectoryDefaults allowSubDirConfig="true" />  
    </sites>  
</system.applicationHost>

Example

The following code example displays all the sites in the system.webServer/sites configuration section for the MACHINE/WEBROOT/APPHOST configuration path.

[!code-cppIAppHostAdminLibrary#2]

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- 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
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Ahadmin.h

See Also

IAppHostElement Interface