通知 (セットアップ API)
通知は、セットアップ関数が状態またはイベントを指定するためにコールバック ルーチンに送信する値です。 Param1 と Param2 の 2 つのパラメーターが通知と共に送信され、通知に関連する追加情報が含まれます。
コールバック ルーチンは通知を処理し、セットアップ関数に符号なし整数を返します。 セットアップ関数に応じて、この値を使用して操作またはユーザーの選択を指定するか、無視することができます。
セットアップ関数は、次の構文を使用してコールバック ルーチンに通知を送信します。
MsgHandler( //the specified callback routine
Context, //context used by the callback routine
Notification, //notification code
Param1, //additional notification information
Param2 //additional notification information
);
Context パラメーターは、コールバック ルーチンがコールバック ルーチンへの後続の呼び出しの間に保持する必要がある情報を格納するために使用できるコンテキスト変数または構造体への void ポインターです。
コールバック ルーチンはコンテキストの実装を指定し、セットアップ関数によって参照または変更されることはないため、コンテキストは後続の通知メッセージの参照資料に記載されていません。
Notification パラメーターは、セットアップ関数がコールバック ルーチンを呼び出す原因となるイベントまたは状態の符号なし整数値を指定します。
Param1 と Param2 は、通知に関連する追加情報を含めることができる省略可能なパラメーターです。 これらのパラメーターは符号なし整数です。 Param1 または Param2 が符号なし整数ではない情報を返す場合、その情報は符号なし整数にキャストされ、コールバック ルーチンで使用する前に元のデータ型に再キャストする必要があります。
Note
次の通知は、セットアップ機能で使用されるすべての通知を表します。 個々の関数では、これらの通知のサブセットが使用されます。 つまり、すべての通知がすべての関数で使用されるわけではありません。
セットアップ機能では、次の通知が使用されます。
| Notification | Description |
|---|---|
| SPFILENOTIFY_COPYERROR | ファイルのコピー操作中にエラーが発生しました。 |
| SPFILENOTIFY_DELETEERROR | ファイルの削除操作中にエラーが発生しました。 |
| SPFILENOTIFY_ENDCOPY | ファイルのコピー操作が終了しました。 |
| SPFILENOTIFY_ENDDELETE | ファイルの削除操作が終了しました。 |
| SPFILENOTIFY_ENDQUEUE | キューのコミットが完了しました。 |
| SPFILENOTIFY_ENDREGISTRATION | ファイルの登録または登録解除が完了しました。 |
| SPFILENOTIFY_ENDRENAME | ファイル名の変更操作が終了しました。 |
| SPFILENOTIFY_ENDSUBQUEUE | サブキュー (コピー、名前の変更、または削除) が終了しました。 |
| SPFILENOTIFY_FILEEXTRACTED | ファイルがキャビネットから抽出されました。 |
| SPFILENOTIFY_FILEINCABINET | キャビネットでファイルが見つかりました。 |
| SPFILENOTIFY_FILEOPDELAYED | ファイルが使用中であり、システムが再起動されるまで、現在の操作が遅延しています。 |
| SPFILENOTIFY_LANGMISMATCH | 現在の操作の言語がシステム言語と一致しません。 |
| SPFILENOTIFY_NEEDMEDIA | 新しいソース メディアが必要です。 |
| SPFILENOTIFY_NEEDNEWCABINET | 現在のファイルは次のキャビネットで続きます。 |
| SPFILENOTIFY_QUEUESCAN | ファイル キュー内のノードがスキャンされました。 |
| SPFILENOTIFY_QUEUESCAN_EX | ファイル キュー内のノードがスキャンされました。 |
| SPFILENOTIFY_QUEUESCAN_SIGNERINFO | ファイル キュー内のノードがスキャンされました。 |
| SPFILENOTIFY_RENAMEERROR | ファイル名の変更操作中にエラーが発生しました。 |
| SPFILENOTIFY_STARTCOPY | ファイル コピー操作が開始されました。 |
| SPFILENOTIFY_STARTDELETE | ファイル削除操作が開始されました。 |
| SPFILENOTIFY_STARTQUEUE | キューのコミットが開始されました。 |
| SPFILENOTIFY_STARTREGISTRATION | ファイルの登録または登録解除が開始されました。 |
| SPFILENOTIFY_STARTRENAME | ファイル名の変更操作が開始されました。 |
| SPFILENOTIFY_STARTSUBQUEUE | サブキュー (コピー、名前の変更、または削除) が開始されました。 |
| SPFILENOTIFY_TARGETEXISTS | 指定したファイルのコピーがターゲットに既に存在します。 |
| SPFILENOTIFY_TARGETNEWER | 指定したファイルの新しいバージョンがターゲットに存在します。 |