CreateLinkedFolder method

Creates a Linked Folder object.

Use IERUExternalStorageProvider::GetExternalStorageTarget() to get an IERUExternalStorageTarget.

Syntax

C++

HRESULT CreateLinkedFolder (



   BSTR Name,

   BSTR Description,

   ERUTextFormat DescriptionFormat,

   IERUExternalStorageTarget* ExternalTarget,

   IERUExternalStorageTarget* ExternalTemplate,

   VARIANT_BOOL SynchAsAdmin,

   LONG* CreateOptions,

   IERUItem** 
 ppLinkedFolder)

`Scripting languages`

Set 
 LinkedFolder = Object.CreateLinkedFolder 
 (

   Name as String,

   Description as String,

   DescriptionFormat as ERUTextFormat,

   ExternalTarget as IERUExternalStorageTarget,

   ExternalTemplate as IERUExternalStorageTarget,

   SynchAsAdmin as Variant,

   CreateOptions as Long)

Parameters

Name

The name of the new linked folder. The name must be unique in the container.

Description

The description of the linked folder.

DescriptionFormat

Indicates whether the Description parameter is in HTML or plain text format.

For further information, see ERUTextFormat.DescriptionFormat

ExternalTarget

Indicates the folder or cabinet on the Documentum server where you would like to create the new linked folder.

ExternalTemplate

Indicates a template you would like to use to create the new linked folder.

SynchAsAdmin

Indicates the Documentum credentials used to synchronize the folder. If true, the administration credentials are used; if false, the logged in member's credentials are used.

CreateOptions

One or more values from the ERUCreateOptions enumeration, logically OR'ed together [default = erCreateOptNone]

For further information, see ERUCreateOption.

ppLinkedFolder

Upon return, An IERUItem interface pointer to the newly-added folder.

Return value

C++

The return code.

Scripting languages

An IERUItem interface pointer to the newly-added linked folder.

Remarks

The name of the linked folder can be no longer than 126 characters.

Home

Interface
IERUContainer

See also
Creating Items