Partager via


IAgentCommandEx ::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

Récupère leHelpContextIDd’un objet Command.

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

pulID

Adresse d’une variable qui reçoit le numéro de contexte de la rubrique d’aide associée à l’objet Command.

Si vous avez créé un fichier d’aide Windows pour votre application et que vous définissez la propriété HelpFile de votre caractère sur ce fichier, Microsoft Agent appelle automatiquement l’aide quand HelpModeOn est défini sur True et 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.

Note

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

 

Voir aussi

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