# WM_GetKeySet

## 構文

      #include <nitro/wm.h>

      WMErrCode WM_GetKeySet( WMKeySetBuf* buf, WMKeySet* keySet );

## 引数

buf | キー情報を格納するバッファへのポインタを指定します。 実体は WMDataSharingInfo 構造体へのポインタです。
`keySet` | キーセットを読み出すバッファへのポインタを指定します。 WM_StartKeySharing( )にて与えたバッファとは別のバッファを指定する必要があります。

## 返り値

WMErrCode列挙型の処理結果を返します。

## 説明

引数として与えられたバッファに、接続している全ての機器で共有されたキー情報であるWMKeySetを格納して返します。 処理落ちや通信の遅延によりkeySetが接続機器間でシェアされていない場合は失敗し、WM_ERRCODE_NO_KEYSETを返します。
理想的な通信状態においては、このAPIはWM_StartMP( )のmpFreqが1の場合でも毎フレーム成功します。ただし、keySetには2回前に成功したWM_GetKeySet( )の呼び出し時点でのキーデータが読み込まれることに注意してください。この制限はmpFreqの値やAPIの呼び出し間隔によらず、常に2回分の遅延が発生します。
毎フレームの安定した動作のためには、Vブランクが来てからできるだけ早いタイミングでこのAPIを呼び出す必要があります。

WM_StartKeySharing( ), WM_EndKeySharing( ), WM_GetKeySet( ) は 過去との互換性のために残されており、今後廃止される予定です。Data Sharing の各関数を代わりに使用してください。

## 参照

`WM_StartKeySharing, WM_EndKeySharing`

## 履歴

2005/06/07 引数の変更
2004/10/22 返り値の型を変更
2004/09/25 説明の加筆・修正
2004/07/29 説明の追加等
2004/07/23 初版