Aide en ligne de Studio DMM › Studio DMM › Structure du langage › Commandes General

Commandes General

Les commandes General suivantes sont utilisées dans les scripts CA DMM :

Break

Permet d'ignorer le flux de contrôle pour accéder directement à la fin de la boucle suivante pour exécuter la première instruction suivant la boucle. Contrairement à la commande break, la commande return quitte toutes les boucles et la portée de la fonction en cours. La commande break est utile uniquement à l'intérieur d'une boucle.

Exemple :

function Foo()
{
     while (true)
     {
          while (z < 5)
          {
               ...
               if (x == false)
               {
               break;     // saute à la ligne suivante tant que (z < 5) {}
               }
               if (y == true)
               {
          return 5;     // retourne immédiatement de Foo()
               }
          }
          if (x == false)
          {
               break;     //  saute à la ligne suivante tant que (true) {}
          }
     }
     ...
     return -1;	// retourne immédiatement de Foo()

}

ConvertBinaryToString

Convertit une chaîne binaire en chaîne ASCII. Le seul paramètre requis est la chaîne contenant les données binaires à convertir. Le second paramètre est facultatif et il s'agit d'une valeur binaire. Si la valeur booléenne est True, elle est alors convertie en une chaîne UNICODE. Si sa valeur est False, elle est alors convertie en une chaîne ASCII.

Premier paramètre :

Chaîne binaire

Deuxième paramètre :

Valeur booléenne

Syntaxe :

ConvertBinaryToString(<valeur>), [booléenne]);

Exemple :

var result = ConvertBinaryToString("000FFFDCB709E")

ConvertStringToBinary

Convertit une chaîne ASCII en chaîne binaire. Le seul paramètre requis est la chaîne ASCII à convertir. Le second paramètre est facultatif. Si ce paramètre a la valeur True, il est alors converti en une chaîne binaire UNICODE.

Premier paramètre :

Chaîne ASCII

Deuxième paramètre :

Valeur booléenne

Syntaxe :

ConvertStringToBinary(<valeur>), [booléenne]);

Exemple :

var result = ConvertStringToBinary("convertir cette chaîne en valeur binaire")

Détection

Définit l'application associée au script. Une seule application peut être associée à un script. Sur l'ordinateur source, elle est appelée à partir de la fonction Detection. Sur l'ordinateur de destination, elle peut être appelée à partir de toutes les fonctions pour résoudre le chemin d'accès à l'application. Le programme d'interprétation résout le mot clé APPLICATIONPATH. Ce mot clé n'est pas valide et ne doit pas être utilisé avant l'émission de cet appel. Le script doit appeler la commande Detect dans la fonction Detection afin d'éviter tout traitement inutile.

Les paramètres de la commande Detect sont le nom du fichier exécutable et une valeur facultative de clé de registre. Les deux paramètres sont des valeurs de chaînes. Le paramètre du chemin d'accès à la valeur de registre correspond au chemin d'accès complet à la valeur de registre contenant le chemin d'accès à l'exécutable. Si la valeur de registre est le paramètre par défaut, le chemin doit se terminer par le nom de la clé et par une barre oblique (voir l'exemple ci-dessous). Dans la fonction Detection, le script doit vérifier la valeur renvoyée par la commande Detect afin de déterminer si le traitement du script doit se poursuivre ou se terminer.

Premier paramètre :

Nom de l'exécutable (valeur de la chaîne)

Deuxième paramètre :

Chemin d'accès au registre (valeur de la chaîne)

Syntaxe :

Detect ( <nom de l'exécutable>, [chemin d'accès au registre] );

Exemples :

if( Detect( "MyApp.exe", "HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\MyApp.exe\\"  ) == false)
{
     return;
}
if (Detect ( <nom de l'exécutable>) == false)
return;

Exécuter

Exécute un fichier exécutable ou une bibliothèque (DLL). Si la fonction d'exécution ne parvient pas à détecter le fichier ou la DLL à utiliser pour émettre l'appel, la valeur false est renvoyée.

Premier paramètre :

Le premier paramètre est le chemin d'accès au fichier à exécuter. Si ce chemin mène à une DLL, la fonction API doit être précédée de deux signes "deux-points". Le format de l'appel de DLL est le suivant : PATH::NomFonctionAPI. La fonction d'exécution d'une DLL recherche uniquement les appels dans deux types de fonctions :

    int FunctionName();

    int FunctionName( const char * );

Deuxième paramètre :

Si l'appel accepte les arguments de ligne de commande, entrez ces arguments ou une chaîne vide.

Troisième paramètre :

Une valeur booléenne indiquant si le script attendra ou non l'exécution complète d'un fichier exécutable. Ce paramètre est ignoré pour les appels de DLL.

Exemples :

/*exécute notepad à l'aide du fichier suivant, monfichier.txt et attend la fin du processus.*/
Execute( "c:\\windows\\notepad.exe", "monfichier.txt", true );

/*exécution de notepad sans paramètres et attente.*/
Execute( "c:\\windows\\notepad.exe" );

/* place un appel de DLL avec les paramètres*/
Execute( "c\\windows\\Somelib.dll::CheckNetwork", "000d1");

**Notez le format utilisé pour la DLL : PATH::NomFonctionAPI

quitter

Quitte un script. Si une valeur suit ce mot clé, elle est consignée dans les journaux de débogage et d'erreurs. Les parenthèses sont facultatives.

Exemples :

Exit ("Fin du programme car MS Word n'est pas détecté sur l'ordinateur.");

ExpandString

Développe toutes les variables d'environnement dans la chaîne donnée et renvoie le résultat.

Premier paramètre :

Chaîne contenant les variables d'environnement.

Syntaxe :

ExpandString(<chaîne>) ;

Exemple :

var result = ExpandString("%WinDir%")

GetEngineData

Renvoie les données relatives au moteur basées sur l'ID commande. Il renvoie l'erreur durant si la valeur de l'ID commande transmise est erronée. Vous pouvez utiliser cette commande lors des deux phases de la migration (stockage et application).

Remarque : Cette commande n'est pas utilisable avec les versions précédentes du produit. Elle générera des erreurs de syntaxes si vous tentez de l'utiliser avec des versions plus anciennes de CA DMM.

Premier paramètre :

IDCommande (par exemple, GET_CUR_SEL) pour obtenir le nom de noeud sélectionné en cours (paramètres d'application ou paramètres système) en vue de la migration.

Syntaxe :

GetEngineData(<IDCommande>);

Exemple :

var strNewPath = GetEngineData(GET_CUR_SEL)

GetMappedPath

Renvoie le nouveau chemin d'accès au fichier mappé au nouvel ordinateur. Par ailleurs, cette commande prend en charge les chemins d'accès dont les délimiteurs diffèrent du caractère \\ utilisé d'ordinaire.

Premier paramètre :

Ancien chemin d'accès au fichier (valeur de chaîne)

Deuxième paramètre :

Délimiteur du chemin d'accès (valeur de chaîne)

Syntaxe :

GetMappedPath( <ancien chemin d'accès au fichier>, [<délimiteur du chemin d'accès>] );

Exemple :

newPath = GetMappedPath("c:\\ancien chemin d'accès\\fichier.txt");
/* newPath sera égal au nouveau chemin d'accès.*/		
oldPath = "c:_ancien chemin d'accès_fichier.txt";
newPath = GetMappedPath( oldPath, "_" );
/* newPath sera égal au nouveau chemin de fichier avec le délimiteur*/

/* par exemple newPath pourra être égal à e:_nouveau fichier_chemin.txt*/

GetPlatform

Renvoie la plate-forme de l'ordinateur. Les valeurs de retour sont : WIN2000, WINXP, WINVI ou WIN7 (consultez la liste des définitions). Ce paramètre indique la plate-forme utilisée par l'ordinateur source ou par l'ordinateur de destination. Ce paramètre est facultatif. Il s'agit d'une valeur booléenne. La valeur par défaut est False. Elle indique le système de destination ; la valeur True indique l'ordinateur actuel.

Remarque : Le paramètre booléen ne peut être utilisé qu'avec les fonctions Validate, General et Apply. A défaut, une erreur de syntaxe ou d'exécution se produit.

Premier paramètre :

Ordinateur (valeur booléenne)

Syntaxe :

GetPlatform( [valeur booléenne] );

Exemple :

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

IsLikeNT

Interroge le système d'exploitation pour déterminer s'il s'agit de Windows 2000, Windows XP, Windows Vista ou Windows 7. Ce paramètre est facultatif. S'il est défini sur True, CA DMM identifie le système d'exploitation de l'ordinateur source. Dans le cas contraire, il identifie le système d'exploitation de l'ordinateur de destination. Par défaut, il est défini sur False.

Remarque : Le paramètre peut uniquement être défini sur True avec les fonctions Validate, General et Apply. Il génère des erreurs de syntaxe ou d'exécution lorsqu'il est utilisé dans une fonction Store.

Premier paramètre :

Ordinateur (valeur booléenne)

Syntaxe :

Value = IsLikeNT([valeur booléenne]);

Exemple :

IsLikeNT(SOURCE);

MapPath

Mappe un chemin d'accès à un autre pendant la durée d'un script. Ce mappage s'applique à toutes les opérations Apply qui suivent le mot clé MapPath dans le script en cours. Ce mot clé remplace tous les chemins d'accès correspondant au paramètre <ancien chemin d'accès> par le paramètre <nouveau chemin d'accès> dans les opérations suivantes : ApplyDirectory, ApplyFile et ApplyMappedValue.

Premier paramètre :

Ancien chemin d'accès (valeur de chaîne)

Deuxième paramètre :

Nouveau chemin d'accès (valeur de chaîne)

Syntaxe :

MapPath(<ancien chemin d'accès>, <nouveau chemin d'accès>);

Exemple :

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

Message

Affiche un message destiné à l'utilisateur. Cette commande utilise un paramètre et une valeur de chaîne. Les parenthèses sont facultatives.

Premier paramètre :

Texte du message (valeur de chaîne)

Syntaxe :

Message ( <chaîne> ) ;

Exemples :

Message ("au secours !");

Option

Crée une option à afficher dans les pages de paramètres. Associe également les fonctions Store et Apply à l'option. Si l'utilisateur choisit une option, les fonctions qui lui sont associées sont appelées par le programme d'interprétation. L'instruction à afficher peut définir une hiérarchie à l'aide de barres obliques. Par exemple, l'option Microsoft Word\\Toolbar affiche Microsoft Word sur une ligne et la barre d'outils en retrait, sur la ligne suivante, dans l'arborescence des options.

Premier paramètre :

Chemin d'accès à l'option (valeur de chaîne)

Deuxième paramètre :

Nom de la fonction Store (valeur de chaîne)

Troisième paramètre :

Nom de la fonction Apply (valeur de chaîne)

Quatrième paramètre :

Voir Exemple : Créer des arborescences de paramètres localisés.

Syntaxe :

Option( <chemin d'accès à l'option>, [nom de la fonction Store], [nom de la fonction Apply], [nom de la fonction Validate], [LanguageIndependentPath]);

Exemples :

Option ( "Microsoft Word\\Toolbar");

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

Si l'élément est sélectionné par l'utilisateur, les fonctions Store et Apply sont appelées par l'interpréteur. Si une option est sélectionnée par l'utilisateur, ses fonctions parentes sont également appelées.

Imprimer

Imprime un message dans le journal d'activité et dans le journal de débogage. Les parenthèses sont facultatives. Cette commande utilise un paramètre (une valeur de chaîne). Veuillez consulter la rubrique Niveaux d'impression pour plus d'informations sur le second paramètre facultatif. Si les niveaux d'impression ne sont pas définis, le paramètre par défaut est GENERAL.

Premier paramètre :

Chaîne (valeur de chaîne)

Syntaxe :

print (<chaîne>);

Exemples :

Print ("Avertissement : le fichier win.ini va être écrasé") 

PrintException

Imprime une chaîne dans le journal d'exceptions. Le journal d'exceptions permet d'afficher les éléments qui n'ont pas pu être transférés par CA DMM ou les instructions post-migration. Par exemple, le script Netscape Communicator imprime dans le journal d'exceptions des instructions détaillées relatives aux procédures de mise à niveau. Le script MS Word imprime quant à lui les paramètres qui n'ont pas pu être mis à niveau. La commande PrintException ne peut être utilisée que dans le cadre de la fonction Apply. Pour plus d'informations sur le second paramètre facultatif, reportez-vous à la section Niveaux d'impression. Si les niveaux d'impression ne sont pas définis, le paramètre par défaut est GENERAL.

Premier paramètre :

Chaîne (valeur de chaîne)

Syntaxe :

PrintException (<chaîne>);

Exemples :

PrintException ("Veuillez supprimer le fichier c:\\windows\\netscapecommunication.ttt");

RetrieveValue

Extrait une valeur de clé de registre de l'ordinateur source ou de l'ordinateur de destination. Accepte trois paramètres : le chemin d'accès à la clé, le nom de la valeur et une valeur booléenne. Les deux premiers paramètres sont obligatoires. Il s'agit de valeurs de chaîne. Le troisième paramètre est facultatif. Si le troisième paramètre est défini sur True, CA DMM effectue la recherche sur l'ordinateur source. Sinon, la recherche se concentre sur l'ordinateur de destination. Par défaut, il est défini sur False. La commande renvoie False si la valeur ne peut pas être extraite.

Remarque : Le troisième paramètre de valeur booléen ne peut être utilisé qu'avec les fonctions Validate, General et Apply. A défaut, une erreur de syntaxe ou d'exécution se produit.

Premier paramètre :

Chemin d'accès à la clé (valeur de chaîne)

Deuxième paramètre :

Nom de la valeur (valeur de chaîne)

Troisième paramètre :

Ordinateur (valeur booléenne)

Syntaxe :

Valeur = RetrieveValue(<chemin d'accès à la clé>, <nom de la valeur>, [valeur booléenne]);

Exemple :

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

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

RestartRequired

Indique à CA DMM d'afficher la boîte de dialogue Redémarrage requis, lorsque la migration est terminée. Utilisez cette fonction pour les scripts qui nécessitent un redémarrage pour terminer la migration avec succès. Le seul paramètre requis est une valeur booléenne qui indique si le script nécessite un redémarrage.

Premier paramètre :

(valeur booléenne)

Syntaxe :

RestartRequired(<valeur booléenne>);

Exemple :

RestartRequired(true);