MMC_TASK structure (mmc.h)

Article
03/04/2024

La structure MMC_TASK est introduite dans MMC 1.1.

La structure MMC_TASK est renseignée par la méthode IEnumTASK ::Next pour spécifier toutes les données requises pour configurer une tâche individuelle sur un bloc-tâches.

Syntaxe

typedef struct _MMC_TASK {
  MMC_TASK_DISPLAY_OBJECT sDisplayObject;
  LPOLESTR                szText;
  LPOLESTR                szHelpString;
  MMC_ACTION_TYPE         eActionType;
  union {
    LONG_PTR nCommandID;
    LPOLESTR szActionURL;
    LPOLESTR szScript;
  };
} MMC_TASK;

Membres

sDisplayObject

MMC_TASK_DISPLAY_OBJECT structure que le composant logiciel enfichable doit remplir pour spécifier l’image à afficher en tant qu’image de la tâche dans le bloc-tâches spécifié par pszGroup.

szText

Pointeur vers une chaîne terminée par null qui contient le texte placé directement à droite de l’image de souris. Ce texte sert d’étiquette pour la tâche. Ce texte doit être une action dans l’impératif, telle que « Ajouter un nouvel utilisateur ».

szHelpString

Pointeur vers une chaîne terminée par un caractère Null qui contient le texte descriptif placé dans le coin supérieur droit lorsque l’utilisateur déplace la souris sur l’image de la souris ou le texte d’étiquette de la tâche. Ce texte sert de description pour la tâche, telle que « Crée un compte, crée une boîte aux lettres et configure tout ce qu’un utilisateur doit accéder au réseau ».

eActionType

Valeur de type MMC_ACTION_TYPE qui spécifie le type d’action déclenché lorsqu’un utilisateur clique sur une tâche sur un bloc-tâches.

Il existe trois types d’actions :

MMC_ACTION_ID

Lorsque l’utilisateur clique sur la tâche, MMC appelle IExtendTaskPad ::TaskNotify et retourne l’ID de commande spécifié dans le membre nCommandID . Si vous spécifiez cette valeur, le membre nCommandID est requis.

MMC_ACTION_LINK

Lorsque l’utilisateur clique sur la tâche, MMC active le lien spécifié par szActionURL. Si vous spécifiez cette valeur, le membre szActionURL est requis.

MMC_ACTION_SCRIPT

Lorsque l’utilisateur clique sur la tâche, MMC exécute le script contenu dans szScript à l’aide de la méthode window.execScript sur la page DHTML du bloc-tâches. Si vous spécifiez cette valeur, le membre zScript est obligatoire.

nCommandID

Utilisé uniquement si eActionType est MMC_ACTION_ID.

Valeur qui spécifie l’ID de commande retourné au composant logiciel enfichable lorsque l’utilisateur clique sur la tâche.

Lorsque MMC appelle IExtendTaskPad ::TaskNotify, il transmet au paramètre arg une structure VARIANT qui contient l’ID de commande de la tâche sur laquelle on a cliqué sur le bloc-tâches. Le champ vt est VT_I4 et le champ lVal contient l’ID de commande.

szActionURL

Utilisé uniquement si eActionType est MMC_ACTION_LINK.

[out] Pointeur vers une chaîne terminée par null qui contient l’URL à laquelle la tâche est liée. L’URL doit être complète. La chaîne peut également contenir un script au lieu d’une URL.

szScript

Utilisé uniquement si eActionType est MMC_ACTION_SCRIPT.

[out] Pointeur vers une chaîne terminée par null qui contient le script à exécuter à l’aide de la méthode window.execScript sur la page DHTML du bloc-tâches. Pour spécifier la langue de script, commencez la chaîne avec la langue de script :

« VBSCRIPT : »
« JSCRIPT : »
« JAVASCRIPT : »

Si aucune langue de script n’est spécifiée, la langue par défaut est JavaScript.

Remarques

Allouez les chaînes szText, szHelpString, szActionURL et szScript utilisées dans la structure avec la fonction d’API COM CoTaskMemAlloc (ou l’équivalent) et MMC les libère.

Vous devez également allouer les chaînes dans la structure MMC_TASK_DISPLAY_BITMAP ou MMC_TASK_DISPLAY_SYMBOL spécifiée dans le membre sDisplayObject avec CoTaskMemAlloc (ou l’équivalent) et MMC les libère.