CreateFolder

Introduced

1.5

Description

Creates a new folder. Folders can be used to organize your scene data. They can be created under other folders or items that support folders like the Clips and Sources (under the Project). Folders can also be created under the Animation Mixer in order to organize your clips.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

    CreateFolder( Target, [Name], [Folder] )

Parameters

Parameter | Type | Description
Target | String | Name of the folder under which the new folder will be created.
Name | String | Name for the new folder. A suffix is appended to the name if there's already such a folder at the given location.
Folder [out] | CollectionItem | The newly created folder. Not Implemented.

Examples

VBScript Example

    '
    ' This example moves all .jpg image clips
    ' under a new folder called JPEG
    '

    ' create an image clip
    Dim clipFile
    clipFile = Application.InstallationPath( siFactoryPath ) _
       & "\Data\XSI_SAMPLES\Pictures\bottom_teeth.jpg"
    CreateImageClip clipFile

    ' Create a folder named JPEG
    CreateFolder "Clips", "JPEG"

    ' Move all jpeg clips under the JPEG folder
    MoveToFolder "Clips.JPEG", "Clips." & "*_jpg"

See Also

MoveToFolder | RemoveFolder | RemoveFromFolder

Autodesk Softimage v7.5