dc_mcf_timer_cancel
- 〈このページの構成〉
形式
ANSI C,C++の形式
#include <dcmcf.h> int dc_mcf_timer_cancel(DCLONG flags,DCLONG timer_id,char *lename)
K&R版 C の形式
#include <dcmcf.h> int dc_mcf_timer_cancel(flags,timer_id,lename) DCLONG flags; DCLONG timer_id; char *lename;
機能
dc_mcf_timer_set関数で設定したユーザタイマ監視を取り消します。
設定したユーザタイマ監視は,dc_mcf_timer_cancel関数が正常にリターンした時点で取り消されています。
また,この関数を呼び出した時点で,設定したユーザタイマ監視がタイムアウトしていて,MHPがすでに起動されている場合には,dc_mcf_timer_cancel関数がDCMCFER_PARAM_TIM_IDでエラーリターンします。
dc_mcf_timer_cancel関数は,ユーザサーバからだけ呼び出せます。
UAPで値を設定する引数
●flags
DCNOFLAGSを設定します。
●timer_id
ユーザタイマ監視を設定したときと同じタイマ要求識別子を指定します。
●lename
ユーザタイマ監視を設定したときと同じ論理端末名称を指定します。論理端末名称の最後にはヌル文字を付けます。
リターン値
リターン値 |
リターン値(数値) |
意味 |
---|---|---|
DC_OK |
0 |
正常に終了しました。 |
DCMCFER_PARAM_TIM_ID |
-11910 |
timer_idに指定したタイマ要求識別子は登録されていません。 |
すでにタイムアウトが発生してMHPが起動されているか,またはすでにユーザタイマ監視が取り消されています。 |
||
DCMCFER_PARAM_FLAGS |
-11911 |
flagsに設定した値が間違っています。 |
DCMCFER_PARAM_LENAME |
-11912 |
lenameに設定した値が間違っています。 |
DCMCFER_NO_DEFINE |
-11916 |
要求された機能はMCFで定義されていません。 |