4. システム API
4.6. キーパッド
GetKeypadSensitivity
目的 1秒以上キーを押下した際のキー連打レートを取得します。
書式 int GetKeypadSensitivity(ref unit value);
引数 ref unit value
[out]キー連打レートを格納するための変数へのポインタを指定します。
C# コーディング例
int b1 = 0;
uint value = new uint();
b1 = Cipherlab.SystemAPI.Member.GetKeypadSensitivity(ref value);
VB コーディング例
Dim b1 As Integer
Dim value As new Uinteger
b1 = Cipherlab.SystemAPI.Member.GetKeypadSensitivity(value)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -
SetKeypadSensitivity
目的 1秒以上キーを押下した際のキー連打レートを設定します。
書式 int GetKeypadSensitivity(unit value);
引数 unit value
[in]キー連打レートを指定します。最大は、20回/秒です。
C# コーディング例 int b1 = 0;
b1 = Cipherlab.SystemAPI.Member.SetKeypadSensitivity(5);
VB コーディング例 Dim b1 As Integer
b1 = Cipherlab.SystemAPI.Member.SetKeypadSensitivity(5)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -
GetKeypadLock
目的 キーパッドのロックステータスを取得します。
書式 int GetKeypadLock(unit key, ref unit lockState);
引数
unit key
[in]キーを指定します。コンビネーションで複数キーを指定することはできません。
引数 定数 意味
1 KEY_GENERAL 一般キー
2 KEY_ALPHA [Alpha]キー
4 KEY_FN [Fn]キー
32 KEY_SCAN [Scan]キー
64 KEY_POWER [Power]キー
128 KEY_LSTRIGGER 左トリガキー 256 KEY_RSTRIGGER 右トリガキー
512 KEY_SHIFT [Shift]キー
0xFFFFFFFF KEY_ALL 全キー ref unit lockState
[out]ロックステータスを格納するための変数へのポインタを指定します。
引数 意味
0 アンロック
1 ロック
C# コーディング例
int b1 = 0;
uint key = 32, plock = 0;
b1 = Cipherlab.SystemAPI.Member.GetKeypadLock(key, ref plock);
VB コーディング例
Dim b1 As Integer
Dim key As Uinteger = 32 Dim plock As Uinteger = 0
b1 = Cipherlab.SystemAPI.Member.GetKeypadLock(key, plock)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 KEY_ALL = KEY_GENERAL + KEY_ALPHA + KEY_FN + KEY_SCAN + KEY_POWER + KEY_LSTRIGGER + KEY_RSTRIGGER + KEY_SHIFT
関連項目 -
SetKeypadLock
目的 キーパッドのロックを制御します。
書式 int SetKeypadLock(unit key, unit lockState);
引数
unit key
[in]キーを指定します。コンビネーションで複数キーを指定することはできません。
引数 定数 意味
1 KEY_GENERAL 一般キー
2 KEY_ALPHA [Alpha]キー
4 KEY_FN [Fn]キー
32 KEY_SCAN [Scan]キー
64 KEY_POWER [Power]キー
128 KEY_LSTRIGGER 左トリガキー 256 KEY_RSTRIGGER 右トリガキー
512 KEY_SHIFT [Shift]キー
0xFFFFFFFF KEY_ALL 全キー ref unit lockState
[in]ロックステータスを指定します。
引数 意味
0 アンロック
1 ロック
C# コーディング例
int b1 = 0;
uint key = 32, plock = 0;
b1 = Cipherlab.SystemAPI.Member.SetKeypadLock(key, plock);
VB コーディング例
Dim b1 As Integer
Dim key As Uinteger = 32 Dim plock As Uinteger = 0
b1 = Cipherlab.SystemAPI.Member.SetKeypadLock(key, plock)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
2 タッチパネルがロックされている(同時ロック不可) 4 ERROR_PARAMETER(パラメータに誤り) 補足
タッチパネルとキーパッドを同時にロックすることはできません。
KEY_ALL = KEY_GENERAL + KEY_ALPHA + KEY_FN + KEY_SCAN + KEY_POWER + KEY_LSTRIGGER + KEY_RSTRIGGER + KEY_SHIFT
関連項目 SetTchLock
GetKeypadMode
目的 キーパッドモードを取得します。
書式 int GetKeypadMode(unit key, ref unit mode);
引数
unit key
[in]キーを指定します。
引数 定数 意味
4 KEY_FN [Fn]キー
ref unit mode
[out]キーパッドモードを格納するための変数へのポインタを指定します。
引数 意味
0 トグルモード
[Fn]キーはトグル動作を行います。一度押すと、[Fn]キーが有効になり、
ディスプレイにアイコンが表示されます。解除するには、再度[Fn]キーを押し ます。
1 オートレジュームモード
[Fn]キーはトグル動作を行います。一度押すと、[Fn]キーが有効になり、
ディスプレイにアイコンが表示されます。次にキーが押されると、自動的に解 除されます。
2 マルチキーモード
「Fn」キーを押した状態で、次の2つ目のキーを押す必要があります。
C# コーディング例
int b1 = 0;
uint key = 4, mode = 0;
b1 = Cipherlab.SystemAPI.Member.GetKeypadMode(key, ref mode);
VB コーディング例
Dim b1 As Integer Dim key As Uinteger = 4 Dim mode As Uinteger = 0
b1 = Cipherlab.SystemAPI.Member.GetKeypadMode(key, mode)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -
SetKeypadMode
目的 キーパッドモードを設定します。
書式 int SetKeypadMode(unit key, unit mode);
引数
unit key
[in]キーを指定します。
引数 定数 意味
4 KEY_FN [Fn]キー
unit mode
[in]キーパッドモードを格納するための変数へのポインタを指定します。
引数 意味
0 トグルモード
[Fn]キーはトグル動作を行います。一度押すと、[Fn]キーが有効になり、
ディスプレイにアイコンが表示されます。解除するには、再度[Fn]キーを押し ます。
1 オートレジュームモード
[Fn]キーはトグル動作を行います。一度押すと、[Fn]キーが有効になり、
ディスプレイにアイコンが表示されます。次にキーが押されると、自動的に解 除されます。
2 マルチキーモード
「Fn」キーを押した状態で、次の2つ目のキーを押す必要があります。
C# コーディング例
int b1 = 0;
uint key = 4, mode = 1;
b1 = Cipherlab.SystemAPI.Member.SetKeypadMode(key, mode);
VB コーディング例
Dim b1 As Integer Dim key As Uinteger = 4 Dim mode As Uinteger = 1
b1 = Cipherlab.SystemAPI.Member.SetKeypadMode(key, mode)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -
GetKeypadState
目的 キーパッドステータスを取得します。
書式 int GetKeypadState(unit key, ref unit state);
引数
unit key
[in]キーを指定します。
引数 定数 意味
2 KEY_ALPHA [Alpha]キー
4 KEY_FN [Fn]キー
ref unit mode
[out]キーパッドステータスを格納するための変数へのポインタを指定します。
引数 [Alpha]キーステータス [Fn]キーステータス
0 数字モート OFF
1 N/A ON
2 小文字モード N/A
C# コーディング例
int b1 = 0;
uint key = 4, state = 0;
b1 = Cipherlab.SystemAPI.Member.GetKeypadState(key, ref state);
VB コーディング例
Dim b1 As Integer Dim key As Uinteger = 4 Dim state As Uinteger = 0
b1 = Cipherlab.SystemAPI.Member.GetKeypadState(key, state)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -
SetKeypadState
目的 キーパッドステータスを設定します。
書式 int SetKeypadState(unit key, unit state);
引数
unit key
[in]キーを指定します。
引数 定数 意味
2 KEY_ALPHA [Alpha]キー
4 KEY_FN [Fn]キー
ref unit mode
[in]キーパッドステータスを指定します。
引数 [Alpha]キーステータス [Fn]キーステータス
0 数字モート OFF
1 N/A ON
2 小文字モード N/A
C# コーディング例
int b1 = 0;
uint key = 4, state = 1;
b1 = Cipherlab.SystemAPI.Member.SetKeypadState(key, state);
VB コーディング例
Dim b1 As Integer Dim key As Uinteger = 4 Dim state As Uinteger = 1
b1 = Cipherlab.SystemAPI.Member.SetKeypadState(key, state)
戻り値
戻り値 意味
0 正常終了
1 エラー終了
エラー終了時は、GetErrorCode()でエラーコードを取得します。
エラーコード 意味
1 キーハンドラ取得失敗 2 キーがロックされている
4 ERROR_PARAMETER(パラメータに誤り)
補足 -
関連項目 -