Freigeben über


IAgentCommandsEx::InsertEx

[Der Microsoft-Agent ist ab Windows 7 veraltet und kann in nachfolgenden Versionen von Windows nicht verfügbar sein.]

HRESULT InsertEx(
   BSTR bszCaption,       // Caption setting for Command
   BSTR bszVoice,         // Voice setting for Command
   BSTR bszVoiceCaption,  // VoiceCaption setting for Command
   long bEnabled,         // Enabled setting for Command
   long bVisible,         // Visible setting for Command
   long ulHelpID,         // HelpContextID setting for Command
   long dwRefID,          // reference Command for insertion
   long dBefore,          // insertion position flag
   long * pdwID           // address for variable for Command ID
);

Fügt ein Command -Objekt in eine Commands -Auflistung ein.

  • Gibt S_OK zurück, um anzugeben, dass der Vorgang erfolgreich war.

bszCaption

Ein BSTR, der den Wert des Caption- Texts angibt, der für den Commandangezeigt wird.

bszVoice

Ein BSTR, der den Wert der Voice- Texteinstellung für eine Commandangibt.

bszVoiceCaption

Ein BSTR, der den Wert des VoiceCaption- Texts angibt, der für eine Command in einer Commands-Auflistung angezeigt wird.

bEnabled

Ein boolescher Ausdruck, der die Einstellung Enabled für ein Command-angibt. Wenn der Parameter Trueist, ist das Command aktiviert und kann ausgewählt werden; wenn False, ist der Command deaktiviert.

bVisible

Ein boolescher Ausdruck, der die Einstellung Visible für eine Commandangibt. Wenn der Parameter Trueist, wird das Command- im Popupmenü des Zeichens angezeigt (wenn auch die eigenschaft Caption festgelegt ist).

ulHelpID-

Die Kontextnummer des Hilfethemas, das dem Command-Objekt zugeordnet ist; wird verwendet, um kontextbezogene Hilfe für den Befehl bereitzustellen.

dwRefID-

Die ID eines Command- als Verweis für die relative Einfügung des neuen Commandverwendet.

dBefore

Ein boolescher Ausdruck, der angibt, wo die Commandplatziert werden soll. Wenn dieser Parameter Trueist, wird das neue Command- vor dem verweisierten Command-eingefügt; wenn False, wird das neue Command nach dem verweisierten Commandplatziert.

pdwID-

Adresse einer Variablen, die die ID für das eingefügte Commandempfängt.

IAgentCommandsEx::InsertEx erweitert IAgentCommands::Insert durch Einschließen der HelpContextID--Eigenschaft. Sie können die Eigenschaft auch mit IAgentCommandsEx::SetHelpContextID-

Siehe auch

IAgentCommandsEx::AddEx, IAgentCommandsEx::SetHelpContextID, IAgentCommands::Add, IAgentCommands::Remove, IAgentCommands::RemoveAll