Partager via

IAgentCommandsEx::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 Commands object help topic ID
);

Récupère le HelpContextID pour un objet Command .

  • 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 l’objet Command .

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 votre objet Command . 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 l’objet Command .

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::SetHelpFileName