Partager via


IAgentCharacterEx::SetHelpFileName

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

HRESULT SetHelpFileName(
   BSTR bszName  // Help filename
);

Définit le HelpFileName pour un caractère.

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

bszName

Nom de fichier d’aide du caractère.

Si vous avez créé un fichier d’aide Windows pour votre application et défini la propriété HelpFile du caractère, Microsoft Agent appelle automatiquement l’aide lorsque HelpModeOn a la valeur True et que l’utilisateur clique sur le caractère ou sélectionne une commande dans son menu contextuel. 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 du caractère par votre application cliente ; le paramètre n’affecte pas les autres clients du caractère ou d’autres caractères de votre application cliente.

Notes

La création d’un fichier d’aide nécessite le compilateur d’aide Microsoft Windows.

 

Voir aussi

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::GetHelpFileName