IAgentCommandsEx ::SetHelpContextID

[Microsoft Agent est déconseillé à partir de Windows 7 et peut être indisponible dans les versions ultérieures de Windows.]

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Définit leHelpContextIDd’un objet Command.

• Retourne S_OK pour indiquer que l’opération a réussi.

ulHelpID

Numéro de contexte de la rubrique d’aide associée à l’objetcommand ; permet de fournir de l’aide contextuelle pour la commande.

Si vous avez créé un fichier d’aide Windows pour votre application et que vous l’avez défini dans la propriété HelpFiledu caractère. L’agent appelle automatiquement l’aide lorsque HelpModeOn est défini sur True et que l’utilisateur sélectionne la commande. S’il existe un numéro de contexte dans le HelpContextID, Agent appelle l’aide et recherche la rubrique identifiée par le numéro de contexte actuel. Le numéro de contexte actuel est la valeur de HelpContextID pour la commande. S’il existe un numéro de contexte dans la propriété HelpContextID de la commande sélectionnée, l’aide affiche une rubrique correspondant au contexte d’aide actuel ; sinon, il affiche « Aucune rubrique d’aide associée à cet élément ».

Cette propriété s’applique uniquement à l’utilisation de votre application cliente du caractère ; le paramètre n’affecte pas d’autres clients du caractère ou d’autres caractères de votre application cliente.

Voir aussi

IAgentCommandsEx ::GetHelpContextID, IAgentCharacterEx ::SetHelpModeOn, IAgentCharacterEx ::SetHelpFileName