FtgRegisterIdleRoutine

[アーティクル]
04/04/2023

適用対象: Outlook 2013 | Outlook 2016

MAPI システムに FNIDLE 関数ベースのアイドルルーチンを追加します。

プロパティ	値
ヘッダーファイル:	Mapiutil.h
実装元:	MAPI
呼び出し元:	クライアントアプリケーションとサービスプロバイダー

FTG FtgRegisterIdleRoutine(
  PFNIDLE pfnIdle,
  LPVOID pvIdleParam,
  short priIdle,
  ULONG csecIdle,
  USHORT iroIdle
);

パラメーター

pfnIdle

[in]アイドルルーチンへのポインター。

pvIdleParam

[in]アイドルエンジンが呼び出すときにアイドル状態のルーチンにパラメーターとして渡すメモリブロックへのポインター。

priIdle

[in]アイドルルーチンの初期優先度。実装定義ルーチンで考えられる優先順位は、0 より大きいか、0 より小さいですが、0 ではありません。優先度 0 は、マウスクリックやWM_PAINT メッセージなどのユーザーイベント用に予約されています。優先度が 0 より大きい場合は、ユーザーイベントよりも優先度が高く、標準の Windows メッセージポンプループの一部としてディスパッチされるバックグラウンドタスクを表します。優先度が 0 未満は、メッセージポンプのアイドル時間中にのみ実行されるアイドルタスクを表します。優先順位の例は、フォアグラウンド送信の場合は 1、power-edit 文字の挿入では 2、新しいメッセージをダウンロードする場合は 3 です。

csecIdle

[in]アイドル状態のルーチンパラメーターを指定する際に使用される、100 分の 1 秒の初期時間値。初期時間値の意味は、 iroIdle パラメーターで渡される内容によって異なります。意味は、次のいずれかになります。

iroIdle で FIROWAIT フラグが設定されている場合、MAPI アイドルエンジンがアイドルルーチンを初めて呼び出す前に経過する必要があるユーザーの操作の最小期間。この時間が経過すると、アイドルエンジンは必要な頻度でアイドルルーチンを呼び出すことができます。
iroIdle で FIROINTERVAL フラグが設定されている場合、アイドルルーチンへの呼び出しの最小間隔。

iroIdle

[in]アイドルルーチンの初期オプションを設定するために使用されるフラグのビットマスク。次のフラグを設定できます。

FIRONOADJUSTMENT

このフラグを使用して、アイドル状態のルーチンタイマーをスリープまたは再開用に調整しないように指定します。このフラグのない既定の動作では、経過時間を計算するときにスリープ時間が除外されます。 FIRONOADJUSTMENT が渡された場合、経過時間の計算時にスリープ時間が含まれます。

FIRODISABLED

登録時にアイドルルーチンを無効にする必要があります。既定のアクションは、 FtgRegisterIdleRoutine によって登録されたときにアイドルルーチンを有効にすることです。

FIROINTERVAL

csecIdle パラメーターで指定された時間は、アイドルルーチンに対する連続する呼び出し間の最小間隔です。

FIROONCEONLY

使用されていません。使用しないでください。

FIROPERBLOCK

使用されていません。使用しないでください。

FIROWAIT

csecIdle パラメーターで指定された時間は、MAPI アイドルエンジンが初めてアイドルルーチンを呼び出す前に経過する必要があるユーザーの操作の最小期間です。この時間が経過すると、アイドルエンジンは必要な頻度でアイドルルーチンを呼び出すことができます。

戻り値

FtgRegisterIdleRoutine 関数は、MAPI システムに追加されたアイドルルーチンを識別する関数タグを返します。 FtgRegisterIdleRoutine は、メモリの問題などのために、クライアントアプリケーションまたはサービスプロバイダーのアイドルルーチンを登録できない場合は、NULL を返します。

注釈

次の関数は、MAPI アイドルエンジンと FNIDLE 関数プロトタイプに基づくアイドルルーチンを扱います。

アイドルルーチン関数	使用状況
ChangeIdleRoutine	登録済みアイドルルーチンの特性を変更します。
DeregisterIdleRoutine	MAPI システムから登録済みのアイドルルーチンを削除します。
EnableIdleRoutine	MAPI システムから削除せずに、登録済みのアイドルルーチンを無効または再び有効にします。
FtgRegisterIdleRoutine	MAPI システムにアイドルルーチンを追加します。有効にするかどうかは関係ありません。
MAPIDeInitIdle	呼び出し元のアプリケーションの MAPI アイドルエンジンをシャットダウンします。
MAPIInitIdle	呼び出し元のアプリケーションの MAPI アイドルエンジンを初期化します。

ChangeIdleRoutine、 DeregisterIdleRoutine、 EnableIdleRoutine は、 FtgRegisterIdleRoutine によって返される関数タグを入力パラメーターとして受け取ります。

プラットフォームのすべてのフォアグラウンドタスクがアイドル状態になると、MAPI アイドルエンジンは、実行する準備ができている最も優先度の高いアイドルルーチンを呼び出します。同じ優先順位のアイドルルーチン間で、呼び出し順序が保証されません。

iroIdle パラメーターで FIRONOADJUSTMENT フラグを使用する例を次に示します。

アイドルルーチンを 5 分の遅延で登録します。
休止状態/1 分後にコンピューターをスリープします (タイマーの残り 4 分)。
10 分後にコンピューターを再開します。

FIRONOADJUSTMENT を使用しない既定の動作は、ルーチンが実行されるまでさらに 4 分待つ必要があるということです。つまり、タイマーは、コンピューターがスリープ状態になっていた時間を許可するように調整されました。ただし、FIRONOADJUSTMENT を渡すと、5 分を超えるリアルタイムが経過したため、アイドルルーチンがすぐに実行されます。

次の方法で共有

FtgRegisterIdleRoutine

パラメーター

戻り値

注釈

その他のリソース