CreateFolderEx

Creates a folder in the document repository, with options for flagging the folder as public or private, overwriting an existing folder, and specifying the type of documents that the folder can contain.

Tip:

If you want to create a folder but do not need to specify the privacy, overwrite, and document type options, you can use CreateFolder.

Syntax

<HFMwManageDocuments>.CreateFolderEx bstrPath, bstrName, bstrDescription, bstrSecurityClass, vbIsPrivate, lContentType, vbOverwriteExisting

Argument

Description

bstrPath

The path of the document repository folder in which to create the new folder. Precede the new folder name with a backslash ( \ ).

Caution!

If the specified path does not exist, an error occurs.

To create the new folder in the root folder, pass an empty string.

Input argument. String subtype.

bstrName

The name of the new folder.

Input argument. String subtype.

bstrDescription

The description of the new folder.

Input argument. String subtype.

bstrSecurityClass

The name of the security class for the folder.

Input argument. String subtype.

vbIsPrivate

Specifies whether the folder is public or private. Pass TRUE for private, FALSE for public.

Input argument. Boolean subtype.

lContentType

Specifies the type of documents that the folder can contain. Valid values are represented by the HFMConstants type library constants listed in Document Type Constants.

Tip:

To specify that the folder can contain any type of document, pass the WEBOM_DOCTYPE_ALL constant.

Input argument. Long subtype.

vbOverwriteExisting

Specifies whether to overwrite any folder of the same name. Pass TRUE to overwrite, FALSE otherwise.

Input argument. Boolean subtype.

Example

The following subroutine creates a private task list folder and takes the folder’s path, name, description, and security class.

Sub CreatePrivateWorkFolder(sPath, sName, sDesc, sSecClass)
Dim cHFMDocuments
Set cHFMDocuments = _ 
   Server.CreateObject("Hyperion.HFMwManageDocuments")
' cHFMSession is a previously set HFMwSession object
cHFMDocuments.SetWebSession cHFMSession
cHFMDocuments.CreateFolderEx sPath, sName, sDesc, sSecClass, _ 
   TRUE, WEBOM_DOCTYPE_WORKSPACE, TRUE
End Sub