IAgentCharacterEx ::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 l'HelpContextID pour le caractère.

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

ulHelpID

Numéro de contexte de la rubrique d’aide associée à un caractère ; permet de fournir de l’aide contextuelle pour le caractère.

Si vous avez créé un fichier d’aide Windows pour votre application et que vous l’avez défini dans la propriété HelpFile du caractère, Microsoft Agent appelle automatiquement l’aide lorsque HelpModeOn est défini sur True et que l’utilisateur sélectionne le caractère. 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 le caractère. S’il existe un numéro de contexte dans la propriété HelpContextID, l’aide affiche une rubrique correspondant au contexte d’aide actuel ; sinon, il affiche « Aucune rubrique d’aide associée à cet élément ».

Ce paramètre s’applique uniquement lorsque votre application cliente est le client actif du caractère le plus haut. Il n’affecte pas d’autres clients du caractère ou d’autres caractères que votre application cliente utilise.

Voir aussi

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