AddContainer

Adds a new container.

 

JavaScript

 

AddContainer(

       Name,

       URL,

       StartupSite)

 

C#

 

int AddContainer(

       string Name,

       string URL,

       ContainerSite StartupSite)

 

C++

 

HRESULT AddContainer(

       BSTR Name,

       BSTR URL,

       ContainerSite StartupSite,

       long* Index)

Parameters

Name

The name that appears on the container caption or on the tab (if multiple windows are placed in the same container).

URL

The URL of the file to be opened in the added container.

StartupSite

An enum that determines where the container is initially docked. The following are the possible values:

·          CS_NOT_VALID = -1,

·          CS_DOCK_LEFT = 0,

·          CS_DOCK_RIGHT= 1

·          CS_DOCK_TOP = 2

·          CS_DOCK_BOTTOM = 3

·          CS_DOCK_FLOAT= 4

·          CS_MAIN = 5

Return Value

Index

The zero-based index of the container to be added.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.