Ajuda online do DMM Studio › DMM Studio › Estrutura de linguagem › Comandos General

Comandos General

Os seguintes comandos General são usados em scripts do CA DMM:

Break

Faz com que o fluxo de controle vá para o final do loop imediato e executa a primeira instrução após o loop. É diferente de return, que sai de todos os loops e do escopo da função. Break somente é relevante em um loop.

Exemplo:

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

Converte uma seqüência de caracteres binários em uma seqüência de caracteres ASCII. Tem um parâmetro obrigatório, que é a seqüência de caracteres contendo os dados binários a serem convertidos. O segundo parâmetro é opcional e é binário. Se o valor booleano for verdadeiro, ele será convertido em uma seqüência de caracteres UNICODE. Mas, se for falso, ele será convertido em uma seqüência de caracteres ASCII.

Primeiro parâmetro:

A seqüência de caracteres binária

Segundo parâmetro:

O valor booleano

Uso:

ConvertBinaryToString(<valor>,[Boolean]);

Exemplo:

var result = ConvertBinaryToString("000FFFDCB709E")

ConvertStringToBinary

Converte uma seqüência de caracteres ASCII em uma seqüência de caracteres. Tem um parâmetro obrigatório, que é a seqüência de caracteres ASCII a ser convertida. O segundo parâmetro é opcional. Se esse parâmetro for verdadeiro, ele será convertido em binário UNICODE.

Primeiro parâmetro:

A seqüência de caracteres ASCII

Segundo parâmetro:

O valor booleano

Uso:

ConvertStringToBinary(<valor>,[Boolean]);

Exemplo:

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

Detect

Especifica o aplicativo associado ao script. Somente um aplicativo pode ser associado a um script. No computador de origem, ele é chamado com a função Detection. No computador de destino, ele pode ser chamado de qualquer lugar para resolver o caminho do aplicativo. O intérprete resolve a palavra-chave APPLICATIONPATH, que não é válida e não deve ser usada antes de esta chamada ser emitida. O script deve chamar Detect na função Detection para evitar processamento desnecessário.

Os parâmetros de Detect são o nome do executável e um valor de chave do Registro opcional. Ambos os parâmetros são valores de seqüência de caracteres. O parâmetro de caminho de valor do Registro é o caminho completo do valor do Registro que contém o caminho para o executável. Se o valor do Registro for o parâmetro padrão, o caminho deverá terminar com o nome da chave e uma barra (veja o exemplo a seguir). Na função Detection, o script deve verificar o valor de retorno de Detect para determinar se deve continuar processando o script ou encerrá-lo.

Primeiro parâmetro:

O nome do executável (valor de seqüência de caracteres)

Segundo parâmetro:

O caminho do Registro (valor de seqüência de caracteres)

Uso:

Detect ( <nome do executável>, [caminho do Registro] );

Exemplos:

if( Detect( "MyApp.exe", "HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\MyApp.exe\\"  ) == false)
{
     return;
}
if (Detect ( <nome do executável>) == false)
return;

Execute

Executa um arquivo executável ou uma dll. Se Execute não conseguir localizar o arquivo ou a dll para fazer a chamada, a função retornará false.

Primeiro parâmetro:

O primeiro parâmetro é o caminho do item que deve ser executado. Se o caminho for de uma dll, a função API deverá estar logo após os dois pontos-e-vírgulas. O formato da chamada dll é PATH::APIFunctionName. A função Execute para a dll procura chamadas somente em dois tipos de funções:

    int FunctionName();

    int FunctionName( const char * );

Segundo parâmetro:

Se a chamada usar argumentos de linha de comando, insira os argumentos ou uma seqüência de caracteres vazia.

Terceiro parâmetro:

Um valor booleano que indica se o script aguardará um executável para ser concluído. Este parâmetro é ignorado para chamadas de dll.

Exemplos:

/*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

Exit

Sai de um script. Se o valor vier após esta palavra-chave, será gravado nos logs de depuração ou de erros. Os parênteses são opcionais.

Exemplos:

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

ExpandString

Expande todas as variáveis de ambiente na seqüência de caracteres especificada e retorna o resultado.

Primeiro parâmetro:

Seqüência de caracteres contendo as variáveis de ambiente.

Uso:

ExpandString(<seqüência de caracteres>);

Exemplo:

var result = ExpandString("%WinDir%")

GetEngineData

Retorna os dados relacionados ao mecanismo no CommandID. Retorna o erro durante a migração se o CommandID errado for passado. Você pode usar este comando nos dos lados - armazenamento e aplicação - da migração.

Observação: você não pode usar este comando com as versões anteriores do produto. Este comando fornecerá erros de sintaxe se você tenta usá-lo nas versões mais antigas do CA DMM.

Primeiro parâmetro:

CommandID (por exemplo, GET_CUR_SEL) para adquirir o nome do nó selecionado atual (configurações de aplicativo ou sistema) para a migração.

Uso:

GetEngineData(<CommandID>);

Exemplo:

var strNewPath = GetEngineData(GET_CUR_SEL)

GetMappedPath

Retorna o novo caminho de arquivo mapeado para uma nova máquina. O comando também pode usar caminhos que têm delimitadores diferentes do caractere \\ normalmente usado.

Primeiro parâmetro:

O antigo caminho do arquivo (valor de seqüência de caracteres)

Segundo parâmetro:

O delimitador de caminho (valor de seqüência de caracteres)

Uso:

GetMappedPath( <antigo caminho do arquivo>, [<delimitador de caminho>] );

Exemplo:

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

Retorna à plataforma do computador. Os valores de retorno são: WIN2000, WINXP, WINVI ou WIN7 (consulte a Lista de definições). É necessário um parâmetro que indique se deve ser informada a plataforma do computador de origem ou do computador de destino. Este parâmetro é opcional e é um valor booleano. O padrão é False e indica o destino; True indica o computador atual.

Observação: o parâmetro Boolean pode ser usado somente durante as funções General e Apply. Se usado de outra forma, ele causa um erro de sintaxe ou de tempo de execução.

Primeiro parâmetro:

A máquina (valor booleano)

Uso:

GetPlatform( [Boolean] );

Exemplo:

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

IsLikeNT

Consulta o sistema operacional para determinar se ele é Windows 2000, Windows XP, Windows Vista ou Windows 7. O parâmetro é opcional. Se True, o CA DMM usará o sistema operacional da máquina de origem, caso contrário, ele usará o sistema da máquina de destino. O padrão é False.

Observação: o parâmetro pode ser definido como Verdadeiro somente durante as funções General e Apply. Ele causa um erro de sintaxe ou de tempo de execução se usado em uma função Store.

Primeiro parâmetro:

A máquina (valor booleano)

Uso:

Value = IsLikeNT([Boolean]);

Exemplo:

IsLikeNT(SOURCE);

MapPath

Mapeia um caminho para outro até o final da duração do script. Este mapeamento de caminho se aplica a todas as operações Apply que vêm após a palavra-chave MapPath no script atual. Esta palavra-chave tem o mesmo efeito de substituir todos os caminhos que correspondem a <antigo caminho> por <novo caminho> nas operações ApplyDirectory, ApplyFile e ApplyMappedValue a seguir.

Primeiro parâmetro:

O antigo caminho (valor de seqüência de caracteres)

Segundo parâmetro:

O novo caminho (valor de seqüência de caracteres)

Uso:

MapPath(<antigo caminho>, <novo caminho>);

Exemplo:

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

Mensagem

Exibe uma mensagem para o usuário. Este comando usa um parâmetro e é um valor de seqüência de caracteres. Os parênteses são opcionais.

Primeiro parâmetro:

O texto da mensagem (valor da seqüência de caracteres)

Uso:

Message ( <seqüência de caracteres> );

Exemplos:

Message ("help!");

Opção

Cria uma opção a ser exibida nas páginas de configurações. Também associa as funções Store e Apply relativas à opção. Se o usuário escolher uma opção, as funções associadas a ela serão chamadas pelo intérprete. A instrução a ser exibida pode especificar uma hierarquia por meio do uso de barras. Por exemplo, a opção Microsoft Word\\Toolbar exibe Microsoft Word em uma linha e Toolbar é exibido recuado na próxima linha, na visualização de opções em árvore.

Primeiro parâmetro:

O caminho de Option (valor de seqüência de caracteres)

Segundo parâmetro:

O nome da função Store (valor de seqüência de caracteres)

Terceiro parâmetro:

O nome da função Apply (valor de seqüência de caracteres)

Quarto parâmetro:

Veja o exemplo: criar árvores de configurações localizadas.

Uso:

Option( <antigo caminho>, [nome da função Store], [nome da função Apply], [nome da função Validate], [LanguageIndependentPath]);

Exemplos:

Option ( "Microsoft Word\\Toolbar");

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

Se o item for selecionado pelo usuário, as funções Store e Apply serão chamadas pelo intérprete. Se uma opção for selecionada pelo usuário, as funções mãe da opção também serão chamadas.

Imprimir

Imprime uma mensagem nos logs de atividades e de depuração. Os parênteses são opcionais. Este comando usa um parâmetro que é um valor de seqüência de caracteres. Para obter informações sobre o segundo parâmetro opcional, consulte Níveis de impressão. Se os níveis de impressão não estiverem especificados, o padrão do parâmetro será GENERAL.

Primeiro parâmetro:

string (valor da seqüência de caracteres)

Uso:

print  (<seqüência de caracteres>);

Exemplos:

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

PrintException

Imprime uma seqüência de caracteres no Log de exceções. O log de exceções é usado para exibir itens que o CA DMM não pôde mover ou instruções pós-migração. Por exemplo, os scripts do Netscape Communicator imprimem instruções detalhadas que descrevem procedimentos de atualização no log de exceções. O script do MS Word imprime configurações que não poderiam ser atualizadas. O comando PrintException pode ser usado somente em ApplyFunction. Consulte Níveis de impressão para obter informações sobre o segundo parâmetro opcional. Se os níveis de impressão não estiverem especificados, o padrão do parâmetro será GENERAL.

Primeiro parâmetro:

string (valor da seqüência de caracteres)

Uso:

PrintException (<seqüência de caracteres>);

Exemplos:

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

RetrieveValue

Recupera um valor de chave do Registro do computador de origem ou de destino. Podem ser três parâmetros: o caminho principal, o nome do valor e um booleano. Os dois primeiros parâmetros são obrigatórios e são valores de seqüência de caracteres. O terceiro parâmetro é opcional. Se o terceiro parâmetro for True, o CA DMM procurará no computador de origem; do contrário, procurará no computador de destino. O padrão é False. O comando retornará False caso o valor não possa ser recuperado.

Observação: o terceiro parâmetro Boolean pode ser usado somente durante as funções General e Apply. Se usado de outra forma, o terceiro parâmetro Boolean causará um erro de sintaxe ou de tempo de execução.

Primeiro parâmetro:

O caminho da chave (valor de seqüência de caracteres)

Segundo parâmetro:

O Nome do valor (valor de seqüência de caracteres)

Terceiro parâmetro:

A máquina (valor booleano)

Uso:

Value = RetrieveValue(<caminho da chave>, <nome do valor>, [Boolean]);

Exemplo:

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

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

RestartRequired

Direciona o CA DMM para exibir a caixa de diálogo de reinicialização necessária ao final de uma migração. Use esta função para scripts que exigem uma reinicialização para que a migração seja bem-sucedida. O único parâmetro exigido é um Boolean indicando se o script requer uma reinicialização.

Primeiro parâmetro:

(valor booleano)

Uso:

RestartRequired(<Boolean>);

Exemplo:

RestartRequired(true);