Partager via

IAgentCharacterEx::GetHelpContextID

  • Article

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

Récupère le HelpContextID pour le caractère.

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

pulHelpID

Adresse d’une variable qui reçoit le numéro de contexte de la rubrique d’aide pour le 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 sélectionne le caractère. S’il existe un numéro de contexte dans helpContextID, l’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.

IAgentCharacterEx::GetHelpContextID retourne le HelpContextID que vous avez défini pour le caractère. Il ne retourne pas le HelpContextID défini par d’autres clients.

Notes

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

 

Voir aussi

IAgentCharacterEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName