GetDocbaseList method

Retrieves the array of Docbase names and whether the list is inclusive or exclusive.

Syntax

C++

HRESULT GetDocbaseList(
   VARIANT DocbaseNameArray,
   VARIANT_BOOL IsExclusionList)

Scripting languages

Object.GetDocbaseList(
   DocbaseNameArray as Variant,
   IsExclusionList as Boolean)

Parameters

DocbaseNameArray

A SAFEARRAY of variants containing Docbase name strings.

IsExclusionList

Whether the DocBaseNameArray is an exclusion list. TRUE means it is an exclusion list; FALSE means it is an inclusion list.

If TRUE is returned, then the names of docbases in DocbaseNameArray correspond to docbases that will be excluded from any list of docbases that appears in eRoom, and all other docbases will be displayed within eRoom. In addition, any new docbases that subsequently appear on the network will automatically appear in eRoom.

If FALSE is returned, then the names of docbases in DocbaseNameArray correspond to docbases that appear in eRoom. In addition, any new docbases that subsequently appear on the network will not automatically appear in eRoom.

Return value

C++

The return code.
Scripting languages

None.

Home

Applies to
IERUDocumentumSettings