API の概要
型
API では、特定の API 関数の引数型としてクライアントが使用できる 3 つの列挙型を提供しています。ソースファイルにヘッダーファイル glasswall.core2.api.h を含め、API 関数を呼び出す際に列挙子を使用してください。
Policy_format
列挙型 Policy_format は、policies ファイルの形式を指定するために使用されます。使用可能な列挙子は次のとおりです。
PF_XML
Analysis_format
列挙型 Analysis_format は、analysis ファイルの形式を指定するために使用されます。使用可能な列挙子は次のとおりです。
AF_XML
ft_t
列挙型 ft_t は、ファイルのファイルタイプ（ファイル形式）を示すために使用されます。これらを使用するには、ソースコードファイルにヘッダーファイル filetype.h を含めてください。
戻り値の型
Glasswall API のほとんどの関数は、成功または失敗を示す値を返します。値とその意味を以下に示します。
| 値 | システム名 | 意味 | 処理応答 |
|---|---|---|---|
| 1 | gw2ret_ok_withcleaning | ファイルは正常に処理されました。サニタイズ、修復、またはその両方が適用されました。 | 管理済みファイルが生成されました |
| 0 | gw2ret_ok | ファイルは正常に処理されました。サニタイズまたは修復は適用されませんでした。 | 管理済みファイルが生成されました |
| -1 | gw2ret_generalfail | 処理中に一般的な障害が発生しました。システムまたはリソースの問題です | Engine Error. |
| -2 | gw2ret_unexpectedEndOfFile | ファイル終端、またはファイル終端マーカーが予期せず検出されました。 | ファイルは処理されましたが、破棄されました。 |
| -3 | gw2ret_licenseExpired | ライセンスファイルの有効期限が切れているか、データが不正または欠落しています。 | Engine Error. |
| -4 | gw2ret_incorrectSessionSetup | policy ファイルの設定値が有効な値ではありません（XSD を参照）。または、登録内容に互換性がありません。例: ソースは 1 つしか指定できないのに、入力ファイルと入力バッファの両方を登録しようとしています。 | Engine Error. |
| -5 | gw2ret_incorrectPolicySetup | policy ファイルを読み込めないか、内容にエラーがあります。 | Engine Error. |
| -6 | gw2ret_unableToLoadInput | 入力ファイルを読み込めないか、それを含むバッファにアクセスできません。 | Engine Error. |
| -7 | gw2ret_fileTypeUnknown | ファイルタイプを判別できません | 認識されないファイルです。 |
| -8 | gw2ret_unknownSessionID | API 呼び出しで使用された Session ID が、アクティブな Sessions の一覧に存在しませんでした。Session は作成されていないか、すでに削除されています。 | Engine Error. |
| -9 | gw2ret_argumentError | API 呼び出し内の引数の 1 つが無効でした。 | Engine Error. |
| -10 | gw2ret_unableToLoadImport | インポートデータファイルを読み込めないか、それを含むバッファにアクセスできません。 | Engine Error. |
| -11 | gw2ret_cameraDidNotInitialise | カメラプラグインの初期化に失敗しました。 | Engine Error. |
| -12 | gw2ret_noCamerasConnected | カメラプラグインが読み込まれていません。 | Engine Error. |
| -13 | gw2ret_engineeringOnlyGoesToFile | 未使用。将来の使用のために予約されています。 | Engine Error. |
| -14 | gw2ret_unableToWriteOutput | 出力ファイル、またはそれを受け取る想定のバッファに書き込めません。 | Engine Error. |
| -15 | gw2ret_unableToWriteExport | エクスポートデータファイル、またはそれを受け取る想定のバッファに書き込めません。 | Engine Error. |
| -16 | gw2ret_fileRejected | ファイルは正常に Processed されましたが、policy 設定により許可されませんでした。analysis または GW2FileErrorMsg API call を参照してください。 | ファイルは処理されましたが、破棄されました。 |
| -17 | gw2ret_unableToWriteExportTextDump | テキストエクスポート出力ファイルに書き込めません。 | Engine Error. |
| -18 | gw2ret_unableToWriteAnalysisReport | analysis レポート出力ファイルに書き込めません。 | Engine Error. |
| -19 | gw2ret_inputTooLarge | 入力ファイルサイズが 2GiB の上限を超えています。 | 無効なファイルです。 |
| -20 | gw2ret_inputZeroBytes | 入力ファイルサイズが 0 バイトです。 | 無効なファイルです。 |
認識済みクリーン
| 値 | システム名 |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
CorruptedRecognised
| 値 | システム名 |
|---|---|
| -2 | gw2ret_unexpectedEndOfFile |
| -16 | gw2ret_fileRejected |
未認識ファイル
| 値 | システム名 |
|---|---|
| -7 | gw2ret_fileTypeUnknown |
Engine エラー
| 値 | システム名 |
|---|---|
| -1 | gw2ret_generalfail |
| -3 | gw2ret_licenseExpired |
| -4 | gw2ret_incorrectSessionSetup |
| -5 | gw2ret_incorrectPolicySetup |
| -6 | gw2ret_unableToLoadInput |
| -8 | gw2ret_unknownSessionID |
| -9 | gw2ret_argumentError |
| -10 | gw2ret_unableToLoadImport |
| -11 | gw2ret_cameraDidNotInitialise |
| -12 | gw2ret_noCamerasConnected |
| -13 | gw2ret_engineeringOnlyGoesToFile |
| -14 | gw2ret_unableToWriteOutput |
| -15 | gw2ret_unableToWriteExport |
| -17 | gw2ret_unableToWriteExportTextDump |
| -18 | gw2ret_unableToWriteAnalysisReport |
無効なファイル
| 値 | システム名 |
|---|---|
| -19 | gw2ret_inputTooLarge |
| -20 | gw2ret_inputZeroBytes |
API functions で説明されている各関数は、詳細な説明で別途記載がない限り、これらの値のいずれかが返されることを前提としています。