IHTMLTxtRange::execCommandShowHelp Method

  • Article

Displays help information for the given command identifier.

Syntax

HRESULT execCommandShowHelp(
    BSTR cmdID,
    VARIANT_BOOL *pfRet
);

Parameters

  • cmdID
    [in] BSTR that contains an identifier of a command. It can be any command identifier given in the list of Command Identifiers.
  • pfRet
    [out] Pointer to a VARIANT_BOOL that receives VARIANT_TRUE if successful, or VARIANT_FALSE otherwise.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Do not invoke the IHTMLTxtRange::execCommand method until after the page loads.

This method is a wrapper function for the IOleCommandTarget::Exec method to enable scriptable execution of some command constants. IOleCommandTarget::Exec provides better performance and greater versatility than this method. You can obtain an IOleCommandTarget interface by calling QueryInterface on the IHTMLTxtRange interface using IID_IHTMLTxtRange for the IID.