WM_SetMPParameter

構文

#include <nitro/wm.h>

WMErrCode WM_SetMPParameter(
        WMCallbackFunc   callback ,
        const WMMPParam* param
);

引数

callback 非同期処理が完了した時に呼び出されるコールバック関数を指定します。
このコールバックは割り込みハンドラ内から呼び出されます。
param MP 通信用のパラメータを格納した構造体へのポインタです。

返り値

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

説明

MP 通信用の各種パラメータを設定します。WM_Initialize( )を呼んだ後であればいつでも呼び出すことができますが、設定するパラメータの内容によっては値を設定できるステートが決まっているものもあります。 基本的には、WM_StartParent( ) や WM_StartConnect( )を呼び出して接続した後、かつ WM_StartMP( ) を呼び出す前に MP の詳細設定を行うために呼び出す関数です。
この関数で設定した値はREADYステートに戻るまで有効です。つまり、一度この関数で値を設定すると、READYステートに戻らずに連続してWM_StartMP( )を呼び出した場合にはその値が引き続き使われます。ただし、WM_StartMP( )およびWM_StartMPEx( )の引数で指定された設定値に関しては、その関数呼び出しによって遷移したMP_PARENT または MP_CHILD ステートの間だけ一時的に設定値が上書きされます。

設定内容などの詳細は WMMPParam 構造体を参照してください。

参照

WMMPParam, WM_StartMP, WM_StartMPEx, WM_SetParentParameter

履歴

2007/05/02 設定した値の有効な範囲を追記
2005/11/24 初版