IAgentCommandEx::GetHelpContextID

[Microsoft Agent är inaktuell från och med Windows 7 och kan vara otillgänglig i efterföljande versioner av Windows.]

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

Hämtar HelpContextID- för ett Kommando-objekt.

• Returnerar S_OK för att indikera att åtgärden lyckades.

pulID

Adress för en variabel som tar emot kontextnumret för hjälpavsnittet som är associerat med objektet Command.

Om du har skapat en Windows-hjälpfil för ditt program och ställt in egenskapen HelpFile till den här filen anropar Microsoft Agent automatiskt Hjälp när HelpModeOn har angetts till True och användaren väljer kommandot. Om det finns ett kontextnummer i HelpContextIDanropar agenten Hjälp och söker efter det ämne som identifieras av det aktuella kontextnumret. Det aktuella kontextnumret är värdet för HelpContextID- för kommandot.

Not

För att skapa en hjälpfil krävs hjälpkompileraren för Microsoft Windows.

 

Se även

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