Ayuda en línea de DMM Studio › DMM Studio › Estructura del lenguaje › Comandos Generales

Comandos Generales

A continuación se indican los comandos General utilizados en los scripts de CA DMM:

Break

Provoca un salto del flujo de control hasta el final del bucle inmediato y la ejecución de la primera instrucción que sigue al bucle. Es diferente a return, que abandona todos los bucles y el ámbito de la función. Break sólo tiene sentido dentro de un bucle.

Ejemplo:

function Foo()
{
     while (true)
     {
          while (z < 5)
          {
               ...
               if (x == false)
               {
               break;     // jumps to line following while (z < 5) {}
               }
               if (y == true)
               {
          return 5;     // returns from Foo() immediately
               }
          }
          if (x == false)
          {
               break;     // jumps to line following while (true) {}
          }
     }
     ...
     return -1;	// returns from Foo() immediately

}

ConvertBinaryToString

Se emplea para convertir una cadena binaria en una cadena ASCII. Requiere un parámetro, que es la cadena con los datos binarios que se han de convertir. El segundo parámetro es opcional y binario. Si el valor booleano es verdadero, se convierte en una cadena UNICODE. En cambio, si es falso, se convierte en una cadena ASCII.

Primer parámetro:

Cadena binaria

Segundo parámetro:

Valor booleano

Uso:

ConvertBinaryToString(<valor>,[Booleano]);

Ejemplo:

var result = ConvertBinaryToString("000FFFDCB709E")

ConvertStringToBinary

Se emplea para convertir una cadena ASCII en una cadena binaria. Requiere un parámetro, que es la cadena ASCII que se ha de convertir. El segundo parámetro es opcional. Si este parámetro es verdadero, se convierte en un binario UNICODE.

Primer parámetro:

Cadena ASCII

Segundo parámetro:

Valor booleano

Uso:

ConvertStringToBinary(<valor>,[Booleano]);

Ejemplo:

var result = ConvertStringToBinary("convert this string to binary")

Detect

Especifica la aplicación asociada al script. A cada script se asocia únicamente una aplicación. En el equipo de origen, se invoca desde la función de Detección. En el equipo de destino, se invoca desde cualquier parte para resolver la ruta de la aplicación. El intérprete resuelve la palabra clave APPLICATIONPATH, que no es válida y no debe usarse antes de emitir esta invocación. El script debe invocar Detect en la función Detection para evitar procesos innecesarios.

Los parámetros de Detect son el nombre del ejecutable y un valor de clave de registro opcional. Ambos parámetros son cadenas. El parámetro de ruta al valor del registro corresponde a la ruta completa hacia el valor del registro que alberga la ruta del archivo ejecutable. Si el valor de registro es un parámetro predeterminado, la ruta debe terminar con el nombre de la clave y una barra invertida (vea el ejemplo que sigue). Al encontrar la función Detection, el script debe comprobar el valor de retorno de Detect para determinar si se continúa procesando el script o se cancela.

Primer parámetro:

Nombre del ejecutable (cadena)

Segundo parámetro:

Ruta del registro (cadena)

Uso:

Detect ( <nombre ejecutable>, [ruta registro] );

Ejemplos:

if( Detect( "MyApp.exe", "HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\MyApp.exe\\"  ) == false)
{
     return;
}
if (Detect ( <nombre ejecutable>) == false)
return;

Execute

Permite ejecutar un archivo ejecutable o un .dll. Si Execute no consigue localizar el archivo o el .dll para realizar la invocación, la función devuelve Falso.

Primer parámetro:

El primer parámetro corresponde a la ruta hacia el archivo que se va a ejecutar. Si la ruta conduce a un archivo .dll, la función API debe ir inmediatamente después de dos signos de dos puntos. El formato de la invocación al archivo .dll es PATH::APIFunctionName. La función Execute para archivos .dll sólo busca invocaciones en dos tipos de funciones:

    int FunctionName();

    int FunctionName( const char * );

Segundo parámetro:

Si la invocación admite argumentos de línea de comandos, indique los argumentos o bien una cadena vacía.

Tercer parámetro:

Se trata de un valor booleano que indica si el script debe o no esperar a que se complete un ejecutable. Este parámetro no se tiene en cuenta en las invocaciones a archivos .dll.

Ejemplos:

/*executes notepad with the following file, myfile.txt and waits for the process to end.*/
Execute( "c:\\windows\\notepad.exe", "myfile.txt", true );

/*executes notepad without parameters and waiting.*/
Execute( "c:\\windows\\notepad.exe" );

/* makes a call into the dll with parameters*/
Execute( "c\\windows\\Somelib.dll::CheckNetwork", "000d1");

**Note the format for dll PATH::APIFunctionName

Salir

Se usa para cerrar un script. Si se coloca un valor detrás de esta palabra clave, se escribe en los registros de depuración y de errores. Los paréntesis son opcionales.

Ejemplos:

Exit ("Exiting because MS Word does not exist on machine.");

ExpandString

Se usa para expandir todas las variables de entorno de la cadena en cuestión y obtener un resultado.

Primer parámetro:

Cadena que contiene las variables de entorno

Uso:

ExpandString(<cadena>);

Ejemplo:

var result = ExpandString("%WinDir%")

GetEngineData

Devuelve datos relacionados con el motor en función del CommandID. Devuelve el error durante la migración si se pasa el CommandID incorrecto. Puede usar este comando en ambos lados de la migración: almacenar y aplicar.

Nota: No se puede utilizar este comando con las versiones anteriores del producto. Este comando generará errores de sintaxis si intenta utilizarlo en las versiones anteriores de CA DMM.

Primer parámetro:

CommandID (por ejemplo, GET_CUR_SEL) para obtener el nombre del nodo actualmente seleccionado (valores de la aplicación o del sistema) para la migración.

Uso:

GetEngineData(<CommandID>);

Ejemplo:

var strNewPath = GetEngineData(GET_CUR_SEL)

GetMappedPath

Devuelve la nueva ruta de archivo asignada al nuevo equipo. Este comando también tiene la capacidad de aceptar rutas con delimitadores diferentes al carácter usual: \\.

Primer parámetro:

Ruta del archivo antigua (cadena)

Segundo parámetro:

Delimitador de la ruta (cadena)

Uso:

GetMappedPath( <ruta archivo antigua>, [<delimitador ruta>] );

Ejemplo:

newPath = GetMappedPath("c:\\old path\\file.txt");
/* newPath will equal the new file path.*/		
oldPath = "c:_old path_file.txt";
newPath = GetMappedPath( oldPath, "_" );
/* newPath will equal the new file path with the delimiter*/

/* for example newPath could equal e:_new path_file.txt*/

GetPlatform

Devuelve la plataforma del equipo. Los valores de retorno son: WIN2000, WINXP, WINVI, o WIN7 (consulte la Lista de definiciones). Consta de un parámetro que indica si se debe obtener la plataforma del equipo de origen o del de destino. Este parámetro, opcional, corresponde a un valor booleano. Falso es el valor predeterminado e indica el equipo de destino; verdadero indica el equipo en uso.

Nota: El parámetro booleano sólo se puede usar durante las funciones General y Apply. Si se usa en otras funciones, se produce un error de sintaxis o de tiempo de ejecución.

Primer parámetro:

Equipo (valor booleano)

Uso:

GetPlatform( [valor booleano] );

Ejemplo:

if (GetPlatform(DESTINATION) == WINXP)
    ApplyWinXPWord();

IsLikeNT

Se consulta el sistema operativo para determinar si se trata de Windows 2000, Windows XP, Windows Vista, o Windows 7. El parámetro es opcional. Si es Verdadero, CA DMM obtiene el SO del equipo de origen; en caso contrario, obtiene el SO del equipo de destino. El valor predeterminado es Falso.

Nota: Sólo puede configurarse el parámetro como Verdadero en las funciones General y Apply. Si se utiliza en una función Store, produce un error de sintaxis o de tiempo de ejecución.

Primer parámetro:

Equipo (valor booleano)

Uso:

Value = IsLikeNT([valor booleano]);

Ejemplo:

IsLikeNT(SOURCE);

MapPath

Permite asignar una ruta a otra durante el desarrollo de un script. Este sistema de asignación de rutas se aplica a todas las operaciones Apply que siguen a la palabra clave MapPath del script. Esta palabra clave sustituye todas las rutas coincidentes con <ruta antigua> por <ruta nueva> en las siguientes operaciones ApplyDirectory, ApplyFile y ApplyMappedValue.

Primer parámetro:

Ruta antigua (cadena)

Segundo parámetro:

Ruta nueva (cadena)

Uso:

MapPath(<ruta antigua>, <ruta nueva>);

Ejemplo:

MapPath("c:\\winword\\data", "c:\\winword\\Application Data");

Mensaje

Muestra un mensaje al usuario. Este comando acepta un parámetro que constituye un valor de cadena. Los paréntesis son opcionales.

Primer parámetro:

Texto del mensaje (cadena)

Uso:

Message ( <cadena> );

Ejemplos:

Message ("help!");

Opción

Crea una opción para que aparezca en las páginas de valores. También asocia las funciones Store y Apply correspondientes a la opción. Si el usuario elige una opción, el intérprete invoca las funciones asociadas a ella. La sentencia que se muestra puede especificar una jerarquía mediante el uso de barras inclinadas. Por ejemplo, la opción Microsoft Word\\Toolbar muestra Microsoft Word en una línea y Toolbar aparece sangrado en la siguiente línea de la vista de árbol correspondiente a las opciones.

Primer parámetro:

Ruta de la opción (cadena)

Segundo parámetro:

Nombre de la función Store (cadena)

Tercer parámetro:

Nombre de la función Apply (cadena)

Cuarto parámetro:

Consulte el ejemplo Creación de árboles de valores localizados .

Uso:

Option( <ruta de opción>, [Store function name], [Apply function name], [LanguageIndependentPath]);

Ejemplos:

Option ( "Microsoft Word\\Toolbar");

Option( "MicrosoftWord\\Toolbar\\Tooltips", "StoreTooltips", "ApplyTooltips", "msword\\toolbar\\tooltips");

Si el usuario selecciona el elemento, el intérprete invoca las funciones Store y Apply. Si el usuario selecciona una opción, también se invocan las funciones superiores de la opción.

Imprimir

Se usa para imprimir un mensaje en el registro de actividades o en el registro de depuración. Los paréntesis son opcionales. Este comando admite un parámetro cuyo valor es una cadena. Si desea obtener información sobre el segundo parámetro opcional, consulte Niveles de impresión. Si no se especifican los niveles de impresión, el valor predeterminado del parámetro es GENERAL.

Primer parámetro:

cadena (cadena)

Uso:

print (<cadena>);

Ejemplos:

Print ("Warning: file win.ini will be overwritten");

PrintException

Permite imprimir una cadena en el registro de excepciones. El registro de excepciones se utiliza para ver los elementos que CA DMM no ha podido mover o bien instrucciones posteriores a la migración. Por ejemplo, el script de Netscape Communicator imprime instrucciones detalladas que describen los procedimientos de actualización en el registro de excepciones. El script de MS Word imprime los valores que no se han podido actualizar. El comando PrintException sólo se puede usar dentro de ApplyFunction. Consulte Niveles de impresión si desea obtener información sobre el segundo parámetro opcional. Si no se especifican los niveles de impresión, el valor predeterminado del parámetro es GENERAL.

Primer parámetro:

cadena (cadena)

Uso:

PrintException (<cadena>);

Ejemplos:

PrintException ("Please remove the file c:\\windows\\netscapecommunication.ttt");

RetrieveValue

Recupera un valor de clave de registro desde el equipo de origen o desde el equipo de destino. Acepta tres parámetros: la ruta de la clave, el nombre del valor y un valor booleano. Los dos primeros parámetros son obligatorios y constituyen valores de cadena. El tercer parámetro es opcional. Si el tercer parámetro es Verdadero, CA DMM realiza la búsqueda en el equipo de origen; de lo contrario, lo hace en el equipo de destino. El valor predeterminado es Falso. El comando devuelve el valor Falso si no se puede recuperar el valor.

Nota: El tercer parámetro booleano sólo se puede usar durante las funciones General y Apply. El tercer parámetro booleano ocasiona un error de sintaxis o de tiempo de ejecución si se usa en otros casos.

Primer parámetro:

Ruta de la clave (cadena)

Segundo parámetro:

Nombre del valor (cadena)

Tercer parámetro:

Equipo (valor booleano)

Uso:

Value = RetrieveValue(<ruta clave>, <nombre valor>, [valor booleano]);

Ejemplo:

RetrieveValue( "HKCU\\Software\\Microsoft\\Office\\8.0\\Common\\Toolbar", "Tooltips", SOURCE);

RetrieveValue( "HKCU\\Software\\Microsoft\\Office\\8.0\\Common\", "Tooltips", DESTINATION);

RestartRequired

Permite instruir a CA DMM para que muestre el cuadro de diálogo Reinicio necesario al término de una migración. Sírvase de esta función en el caso de script que exijan el reinicio para completar la migración. El único parámetro requerido consiste en un valor booleano que indique si el script exige el reinicio.

Primer parámetro:

(valor booleano)

Uso:

RestartRequired(<valor booleano>);

Ejemplo:

RestartRequired(true);