TPI_MESSAGE_ASK,TPI_CALLBACK_SKIP,TPI_ERROR_S_ENDOFDATAなどを追加し、幾つかの定数の値を変更。

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/tpi/tpi@81 9df91469-1e22-0410-86e7-ea8537beb833

diff --git a/src/common/header/plugin.h b/src/common/header/plugin.h
index 542ae8a..1833deb 100644 (file)
--- a/src/common/header/plugin.h
+++ b/src/common/header/plugin.h
@@ -46,8 +46,15 @@
  * 各APIを実行した場合に返される、異常の理由を表す一意の数値。\r
  * @{\r
  */\r
+/**\r
+ * @defgroup c_error_success 成功値\r
+ * 異常が発生しなかった場合の返し値。\r
+ * @{\r
+ */\r
 /** 異常が発生せず、正常に処理を終了した。 */\r
-#define TPI_ERROR_SUCCESS           TRUE\r
+#define TPI_ERROR_SUCCESS           1000\r
+#define TPI_ERROR_S_ENDOFDATA       TPI_ERROR_SUCCESS + 1 /**< データの終端に到達し、得られる項目がなくなった。 */\r
+/** @} c_error_success */\r
 \r
 /**\r
  * @defgroup c_error_undefined 未定義エラー\r
@@ -163,11 +170,12 @@
 /** 進捗状況についての情報を TPI_PROCESSINFO に格納。 */\r
 /** @sa c_process_common_status */\r
 /** @sa TPI_PROCESSINFO */\r
-#define TPI_MESSAGE_STATUS          0x0001\r
+#define TPI_MESSAGE_STATUS          0x0001 \r
+#define TPI_MESSAGE_ASK             0x0002  /**< 何らかのパラメータが要求された。 */\r
 /** 処理中に続行不可能なエラーが発生した。 */\r
 /** @sa c_error */\r
-#define TPI_MESSAGE_ERROR           0x0002\r
-#define TPI_MESSAGE_WARNING         0x0003  /**< 処理中に続行可能な警告が発生した。 */\r
+#define TPI_MESSAGE_ERROR           0x1000\r
+#define TPI_MESSAGE_WARNING         0x1001  /**< 処理中に続行可能な警告が発生した。 */\r
 /** @} c_process_common */\r
 \r
 /**\r
@@ -188,6 +196,16 @@
 /** @} c_process_common_status */\r
 \r
 /**\r
+ * @defgroup c_process_common_param パラメータコード\r
+ * TPI_MESSAGE_ASK が送信された時に、TPI_PROCESSINFO 構造体の uStatus に格納される値で、要求されているパラメータを示す値。\r
+ * @sa TPI_MESSAGE_STATUS\r
+ * @sa TPI_PROCESSINFO::uStatus\r
+ * @{\r
+ */\r
+#define TPI_PARAM_PASSWORD          0x0001  /**< パスワード。 */\r
+/** @} c_process_common_param */\r
+\r
+/**\r
  * @defgroup c_callback_return コールバック関数の返し値\r
  * コールバック関数の終了時に、返し値として指定し、処理の続行について指示する値。\r
  * @sa TPI_PROC\r
@@ -195,7 +213,8 @@
  */\r
 #define TPI_CALLBACK_CONTINUE       TRUE    /**< 処理を続行する。 */\r
 #define TPI_CALLBACK_CANCEL         0x1000  /**< 処理を中断する。 */\r
-#define TPI_CALLBACK_UNSUPPORTED    0x1001  /**< 処理を無視した。不明な処理である。 */\r
+#define TPI_CALLBACK_SKIP           0x1001  /**< 現在の処理を行わず、次の処理を行う。 */\r
+#define TPI_CALLBACK_UNSUPPORTED    0x1002  /**< 処理を無視した。不明な処理である。 */\r
 /** @} c_callback_return */\r
 \r
 /**\r
@@ -322,6 +341,7 @@ typedef struct _TPI_tagPROCESSINFO
        TPI_FILEINFO    fiInfo;                 /**< 処理中のファイルに関する情報 */\r
        wxULongLong     llProcessedSize;        /**< 処理済サイズ */\r
        wxFileName      fnDestination;          /**< 出力先ファイル */\r
+       wxString        szParam;                /**< パラメータを格納 */\r
        void *          pCustomInfo;            /**< 任意の情報を格納 */\r
 }      TPI_PROCESSINFO;\r
 \r
@@ -371,8 +391,8 @@ int __stdcall GetPluginInformation
 \r
 /** 対応形式に関する情報を取得。\r
  * @param  _fiInfo      取得した情報を格納するためのポインタ。\r
- * @param  _bFirst      最初の形式から情報を取得する場合にはTRUE。\r
- * @return エラーコード。\r
+ * @param  _bFirst      最初の形式から情報を取得する場合にはtrue。\r
+ * @return エラーコード。得られる情報がなくなった場合はTPI_ERROR_S_ENDOFDATAが返される。\r
  * @sa c_info\r
  */\r
 int __stdcall GetFormatInformation\r
@@ -435,8 +455,8 @@ int __stdcall CloseArchive
 /** 書庫に格納されているファイルの情報を順に取得する。\r
  * @param  _hArchive    操作する対象となる書庫ハンドル。\r
  * @param  _fiInfo      取得した情報を格納するためのポインタ。\r
- * @param  _bFirst      最初のファイルから情報を取得する場合にはTRUE。\r
- * @return エラーコード。\r
+ * @param  _bFirst      最初のファイルから情報を取得する場合にはtrue。\r
+ * @return エラーコード。得られる情報がなくなった場合はTPI_ERROR_S_ENDOFDATAが返される。\r
  */\r
 int __stdcall GetFileInformation\r
 (\r