Méthode RetrieveCommandInformation()
Description
La méthode RetrieveCommandInformation interroge l’API QCDRCMDI pour obtenir des informations détaillées sur une commande CL.
Elle renvoie un objet CommandInformation contenant des attributs associés à la commande, tels que le programme de traitement associé, le fichier source et d’autres informations pertinentes.
Cette méthode utilise le format CMDI0100 pour récupérer les informations de base sur la commande.
Syntaxe
RetrieveCommandInformation(string commandName, string commandLibrary = "*LIBL")Paramètres
| Nom | Type | Description |
|---|---|---|
commandName |
string |
Le nom de la commande à interroger (maximum 10 caractères). |
commandLibrary |
string |
La bibliothèque contenant la commande (max 10 caractères, défaut : *LIBL). |
Retour
Retourne un objet de type CommandInformation contenant des informations détaillées sur la commande CL spécifiée.
Classe CommandInformation
| Propriété | Type | Description |
|---|---|---|
| CommandName | string |
Nom de la commande CL. |
| CommandLibraryName | string |
Nom de la bibliothèque contenant la commande. |
| CommandProcessingProgram | string |
Nom du programme de traitement de la commande (Programme CL associé). |
| CommandProcessingProgramLibraryName | string |
Nom de la bibliothèque contenant le programme de traitement de la commande. |
| SourceFileName | string |
Nom du fichier source associé à la commande. |
| SourceFileLibraryName | string |
Nom de la bibliothèque contenant le fichier source. |
| SourceFileMemberName | string |
Nom du membre du fichier source associé à la commande. |
| ValidityCheckProgramName | string |
Nom du programme de vérification de validité pour la commande. |
| ValidityCheckProgramLibraryName | string |
Nom de la bibliothèque contenant le programme de vérification de validité. |
| ModeInformation | string |
Mode d’information de la commande (indique comment la commande est exécutée). |
| WhereAllowedToRun | string |
Indique où la commande est autorisée à s'exécuter (ex. : *BATCH, *INTERACTIF, etc.). |
| AllowLimitedUser | string |
Indique si l’utilisateur limité peut exécuter la commande. |
| MaximumPositionalParameters | int |
Nombre maximum de paramètres positionnels acceptés par la commande. |
| PromptMessageFileName | string |
Nom du fichier de message de prompt utilisé par la commande. |
| PromptMessageFileLibraryName | string |
Nom de la bibliothèque contenant le fichier de message de prompt. |
| MessageFileName | string |
Nom du fichier de message associé à la commande. |
| MessageFileLibraryName | string |
Nom de la bibliothèque contenant le fichier de message. |
| HelpPanelGroupName | string |
Nom du groupe de panneaux d’aide associé à la commande. |
| HelpPanelGroupLibraryName | string |
Nom de la bibliothèque contenant le groupe de panneaux d’aide. |
| HelpIdentifier | string |
Identifiant de l’aide de la commande. |
| SearchIndexName | string |
Nom de l’index de recherche associé à la commande. |
| SearchIndexLibraryName | string |
Nom de la bibliothèque contenant l’index de recherche. |
| CurrentLibrary | string |
Nom de la bibliothèque active lors de l’exécution de la commande. |
| ProductLibrary | string |
Nom de la bibliothèque produit associée à la commande. |
| PromptOverrideProgramName | string |
Nom du programme de remplacement de prompt pour la commande. |
| PromptOverrideProgramLibraryName | string |
Nom de la bibliothèque contenant le programme de remplacement de prompt. |
| RestrictedToTargetRelease | string |
Indique si la commande est restreinte à une version cible spécifique. |
| TextDescription | string |
Description textuelle de la commande. |
| CommandProcessingProgramCallState | string |
État d’appel pour le programme de traitement de la commande. |
| ValidityCheckProgramCallState | string |
État d’appel pour le programme de vérification de validité. |
| PromptOverrideProgramCallState | string |
État d’appel pour le programme de remplacement de prompt. |
| OffsetToHelpBookshelfInformation | int |
Décalage pour accéder aux informations de l'étagère d’aide (Help Bookshelf) dans le bloc de données. |
| LengthOfHelpBookshelfInformation | int |
Longueur des informations de l'étagère d’aide. |
| CodedCharacterSetID | int |
Identifiant de jeu de caractères codé (CCSID) pour la commande. |
| EnabledForGUIIndicator | string |
Indicateur d’activation pour l’interface utilisateur graphique (GUI). |
| ThreadsafeIndicator | string |
Indicateur de sécurité pour les threads, précisant si la commande est compatible avec l'exécution multi-thread. |
| MultithreadedJobAction | string |
Action définie lorsque la commande est exécutée dans un job multi-thread. |
| ProxyCommandIndicator | string |
Indicateur précisant si la commande est une commande proxy. |
| PromptMessageFileTextIndicator | string |
Indicateur de texte pour le fichier de message de prompt, spécifiant la source du texte d’aide. |
Exceptions
- InvalidOperationException : Lancée lorsque la taille des données retournées est insuffisante.
Exemples d’utilisation
var commandInfo = conn.RetrieveCommandInformation("CRTLIB", "QSYS");
Console.WriteLine($"Command: {commandInfo.CommandName}, Processing Program: {commandInfo.CommandProcessingProgram}");Références
Pour plus d’informations sur l’API QCDRCMDI, consultez la documentation officielle IBM.
