/*--------------------------------------------------------------------
        This example shows how to register and implement a custom command 
        When not specified, the Name argument is also used as the 
        command's scripting name. 
        README: Copy and paste the example into the script editor 
        and run (F5).
        The command will be listed in the customize toolbar dialog in
        the 'Custom Commands' group.
--------------------------------------------------------------------*/
function  XSILoadPlugin( in_reg )
{
        in_reg.Author = "Softimage Co."; 
        in_reg.Name = "PluginRegistrar.RegisterCommand Example";
        in_reg.Major = 1;
        in_reg.Minor = 0;
        // register the ABC command plug-in item
        in_reg.RegisterCommand("ABCCommand", "ABC");
        return true;
} 
// initialize the ABC command arguments
function  ABCCommand_Init( in_ctxt )
{
        var cmd = in_ctxt.Source;
        cmd.Arguments.Add("argument0");
        return true;
}
//function handler for the ABC command
function  ABCCommand_Execute( in_arg )
{
        Application.LogMessage("ABC command has been executed with argument: " + in_arg);
}
//--------------------------------------------------------------------
// Code to bootstrap example into system
//--------------------------------------------------------------------
function ExampleSourceCode()
{
        return "// XSISDK Doc Example\n" +
                ABCCommand_Init.toString() + "\n" + 
                ABCCommand_Execute.toString() + "\n" + 
                XSILoadPlugin.toString();
}
// if we are running from script editor save code to 
// examples addon folder in the user's directory.
if (GetUserPref("ScriptingSessionActive"))
{
        var ex_name             = "ExPluginRegistrarRegisterCommand";
        var ex_subfolder        = "Plugins";
        var ex_folder           = "XSISDKDocExamples";
        var ex_langsuffix       = ".js";
        CreateAddonDirectories( InstallationPath(siUserPath), ex_folder );
        var fso = XSIFactory.CreateActiveXObject("Scripting.FileSystemObject");
        var filename = XSIUtils.BuildPath( 
                InstallationPath(siUserAddonPath), 
                ex_folder,
                "Application",
                ex_subfolder,
                ex_name+ex_langsuffix );
        if (!fso.FileExists(filename))
        {
                var f = fso.CreateTextFile ( filename );
                f.write( ExampleSourceCode() );
                f.close();
                Application.LoadPlugin(filename);       
        }
}