ChangeIdleRoutine
適用対象: Outlook 2013 | Outlook 2016
FNIDLE ベースのアイドル・ルーチンの特性の一部またはすべてを変更します。
値 | 説明 |
---|---|
ヘッダー ファイル: |
Mapiutil.h |
実装元: |
MAPI |
呼び出し元: |
クライアント アプリケーションとサービス プロバイダー |
VOID ChangeIdleRoutine(
FTG ftg,
PFNIDLE pfnIdle,
LPVOID pvIdleParam,
short priIdle,
ULONG csecIdle,
USHORT iroIdle,
USHORT ircIdle
);
パラメーター
ftg
[in]アイドル ルーチンを識別する関数タグ。
pfnIdle
[in]アイドル ルーチンへのポインター。
pvIdleParam
[in]呼び出し元の実装がアイドル ルーチンに割り当てる新しいメモリ ブロックへのポインター。
priIdle
[in]アイドル ルーチンの新しい優先順位を表す値。 実装定義ルーチンで考えられる優先順位は、0 より大きいか、0 より小さいですが、0 ではありません。 値 0 は、マウス クリックやWM_PAINT メッセージなどのユーザー イベント用に予約されています。 0 より大きい値は、ユーザー イベントよりも優先度が高く、標準の Windows メッセージ ポンプ ループの一部としてディスパッチされるバックグラウンド タスクの優先順位を表します。 0 未満の値は、メッセージ ポンプのアイドル時間中にのみ実行されるアイドル タスクの優先順位を表します。 優先順位の例としては、フォアグラウンド送信の場合は 1、power-edit 文字の挿入には 1、新しいメッセージをダウンロードする場合は 3 です。
csecIdle
[in]アイドル ルーチンに適用する新しい時刻 (100 分の 1 秒)。 初期時間値の意味は、 iroIdle パラメーターで渡される内容によって異なります。 次のことができます。
iroIdle で FIROWAIT フラグが設定されている場合、MAPI アイドル エンジンがアイドル ルーチンを初めて呼び出す前に経過する必要があるユーザーの操作の最小期間。 この時間が経過すると、アイドル エンジンは必要な頻度でアイドル ルーチンを呼び出すことができます。
iroIdle で FIROINTERVAL フラグが設定されている場合、アイドル ルーチンへの呼び出しの最小間隔。
iroIdle
[in]アイドル ルーチンを呼び出すための新しいオプションを示すフラグのビットマスク。 次のいずれかのフラグを設定する必要があります。
FIROINTERVAL: csecIdle パラメーターで指定された時間は、アイドル ルーチンへの連続する呼び出し間の最小間隔です。
FIROONCEONLY: 廃止されました。 使用しないでください。
FIROPERBLOCK: 廃止されました。 使用しないでください。
FIROWAIT: csecIdle パラメーターで指定された時間は、MAPI アイドル エンジンが初めてアイドル ルーチンを呼び出す前に経過する必要があるユーザーの操作の最小期間です。 この時間が経過すると、アイドル エンジンは必要な頻度でアイドル ルーチンを呼び出すことができます。
ircIdle
[in]アイドル ルーチンに加えられる変更を示すために使用されるフラグのビットマスク。 次のフラグは、任意の組み合わせで設定できます。
FIRCCSEC: アイドル ルーチンに関連付けられている時刻の変更、つまり csecIdle パラメーターで渡された値によって示される変更。
FIRCIRO: アイドル ルーチンのオプションの変更、つまり iroIdle パラメーターで渡された値によって示される変更。
FIRCPFN: アイドル・ルーチン・ポインターへの変更 、つまり pfnIdle パラメーターで渡された値によって示される変更。
FIRCPRI: アイドル・ルーチンの優先順位への変更、つまり priIdle パラメーターで渡された値によって示される変更。
FIRCPV: アイドル・ルーチンのメモリー・ブロックへの変更 、つまり pvIdleParam パラメーターで渡された値によって示される変更。
戻り値
なし。
注釈
次の関数は、MAPI アイドル エンジンと 、FNIDLE 関数プロトタイプに基づくアイドル ルーチンを扱います。
アイドル ルーチン関数 | 使用状況 |
---|---|
ChangeIdleRoutine |
登録済みアイドル ルーチンの特性を変更します。 |
DeregisterIdleRoutine |
MAPI システムから登録済みのアイドル ルーチンを削除します。 |
EnableIdleRoutine |
MAPI システムから削除せずに、登録済みのアイドル ルーチンを無効または再び有効にします。 |
FtgRegisterIdleRoutine |
MAPI システムにアイドル ルーチンを追加します。有効にするかどうかは関係ありません。 |
MAPIDeInitIdle |
呼び出し元のアプリケーションの MAPI アイドル エンジンをシャットダウンします。 |
MAPIInitIdle |
呼び出し元のアプリケーションの MAPI アイドル エンジンを初期化します。 |
ChangeIdleRoutine、 DeregisterIdleRoutine、 EnableIdleRoutine は、 FtgRegisterIdleRoutine によって返される関数タグを入力パラメーターとして受け取ります。
プラットフォームのすべてのフォアグラウンド タスクがアイドル状態になると、MAPI アイドル エンジンは、実行する準備ができている最も優先度の高いアイドル ルーチンを呼び出します。 同じ優先順位のアイドル ルーチン間で、呼び出し順序が保証されません。