> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Méthode RegisterUserCommand de l’objet Commands

> Méthode RegisterUserCommand de l’objet Commands dans les composants visuels d’ABBYY FineReader Engine sous Windows — Cette méthode enregistre une commande définie par l’utilisateur.

Cette méthode enregistre une commande définie par l’utilisateur. Cette commande peut ensuite être ajoutée à une barre d’outils ou exécutée à l’aide de la méthode [ICommands::DoCommand](/fr/fine-reader/engine/visual-components-reference/supplementary-objects/commands/docommand-method).

<div id="syntax">
  ## Syntaxe
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT RegisterUserCommand(
  MenuItemEnum CommandId,
  BSTR         CommandText,
  BSTR         IconPath,
  int          HotKey
);
```

### C\#

```csharp theme={null}
void RegisterUserCommand(
  MenuItemEnum CommandId,
  string       CommandText,
  string       IconPath,
  int          HotKey
);
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Sub RegisterUserCommand( _
  CommandId As MenuItemEnum, _
  CommandText As String, _
  IconPath As String, _
  HotKey As Integer _
)
```

<div id="parameters">
  ## Paramètres
</div>

CommandId

\[in] Spécifie l’ID attribué à la commande utilisateur sous la forme d’une constante [MenuItemEnum](/fr/fine-reader/engine/visual-components-reference/enumerations/menuitemenum). Peut prendre les valeurs MI\_CustomCommand1, ... , MI\_CustomCommand10.

CommandText

\[in] Spécifie le texte de la commande utilisateur.

IconPath

\[in] Spécifie le chemin d’accès au fichier contenant une image BMP de 16х16 qui sera utilisée comme icône de la commande.

HotKey

\[in] Spécifie le raccourci clavier de la commande. Le paramètre a le même format que la valeur renvoyée (LRESULT) par la fonction Windows [SendMessage](http://msdn.microsoft.com/en-us/library/ms644950\(VS.85\).aspx) pour le message [HKM\_GETHOTKEY](http://msdn.microsoft.com/en-us/library/windows/desktop/bb775235\(v=vs.85\).aspx). Pour obtenir la valeur du raccourci clavier dans ce format, vous devez placer le code de touche virtuelle du raccourci clavier dans l’octet de poids faible de la valeur, et le modificateur indiquant les touches qui définissent une combinaison de raccourci clavier dans l’octet de poids fort. Si vous n’avez pas besoin d’utiliser de raccourci clavier pour la commande, transmettez 0 à ce paramètre. Si ce raccourci clavier est déjà utilisé par une autre commande, une erreur est renvoyée. Vous pouvez vérifier la disponibilité d’un raccourci clavier à l’aide de la méthode [ICommands::HasHotKey](/fr/fine-reader/engine/visual-components-reference/supplementary-objects/commands/hashotkey-method).

<div id="return-values">
  ## Valeurs de retour
</div>

Cette méthode n’a pas de valeur de retour spécifique. Elle renvoie les [valeurs de retour standard des fonctions ABBYY FineReader Engine](/fr/fine-reader/engine/api-reference/return-codes).

<div id="see-also">
  ## Voir aussi
</div>

[Commands](/fr/fine-reader/engine/visual-components-reference/supplementary-objects/commands)

[UnregisterUserCommand](/fr/fine-reader/engine/visual-components-reference/supplementary-objects/commands/unregisterusercommand-method)

[MenuItemEnum](/fr/fine-reader/engine/visual-components-reference/enumerations/menuitemenum)