> ## 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.

# Commands オブジェクトの RegisterUserCommand メソッド

> Windows 上の ABBYY FineReader Engine Visual Components における Commands オブジェクトの RegisterUserCommand メソッド — このメソッドでは、ユーザー定義コマンドを登録します。

このメソッドでは、ユーザー定義コマンドを登録します。登録したコマンドは、ツールバーに追加することも、[ICommands::DoCommand](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/commands/docommand-method) メソッドで実行することもできます。

<div id="syntax">
  ## 構文
</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">
  ## パラメーター
</div>

CommandId

\[in] ユーザーコマンドに割り当てられた ID を、[MenuItemEnum](/ja/fine-reader/engine/visual-components-reference/enumerations/menuitemenum) 定数として指定します。指定できる値は MI\_CustomCommand1, ... , MI\_CustomCommand10 です。

CommandText

\[in] ユーザーコマンドのテキストを指定します。

IconPath

\[in] コマンドのアイコンとして使用する、16×16 サイズの BMP 画像を含むファイルへのパスを指定します。

HotKey

\[in] コマンドのホットキーを指定します。このパラメーターは、Windows の [SendMessage](http://msdn.microsoft.com/en-us/library/ms644950\(VS.85\).aspx) 関数に [HKM\_GETHOTKEY](http://msdn.microsoft.com/en-us/library/windows/desktop/bb775235\(v=vs.85\).aspx) メッセージを送信したときの戻り値 (LRESULT) と同じ形式です。この形式でホットキー値を取得するには、ホットキーの仮想キー コードを値の下位バイトに、ホットキーの組み合わせを定義するキー修飾子を上位バイトに格納する必要があります。コマンドにホットキーを使用しない場合は、このパラメーターに 0 を渡します。別のコマンドがこのホットキーを使用している場合は、エラーが返されます。[ICommands::HasHotKey](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/commands/hashotkey-method) メソッドを使用して、ホットキーが使用可能かどうかを確認できます。

<div id="return-values">
  ## 戻り値
</div>

このメソッドには特定の戻り値はありません。代わりに、[ABBYY FineReader Engine 関数の標準的な戻り値](/ja/fine-reader/engine/api-reference/return-codes)が返されます。

<div id="see-also">
  ## 関連項目
</div>

[コマンド](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/commands)

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

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