API 개요
유형
API는 특정 API 함수의 인수 유형으로 클라이언트가 사용할 수 있도록 세 가지 열거형을 제공합니다. 소스 파일에 헤더 파일 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 | 처리 중 일반 오류가 발생했습니다. 시스템 또는 리소스 문제입니다. | 엔진 오류. |
| -2 | gw2ret_unexpectedEndOfFile | 파일 끝 또는 파일 끝 마커가 예기치 않게 감지되었습니다. | 파일이 처리되었지만 폐기되었습니다. |
| -3 | gw2ret_licenseExpired | 라이선스 파일이 만료되었거나 데이터가 올바르지 않거나 누락되었습니다. | 엔진 오류. |
| -4 | gw2ret_incorrectSessionSetup | policy 파일 설정이 유효한 값이 아닙니다(XSD 참조). 또는 등록이 호환되지 않습니다. 예: 하나의 소스만 가질 수 있는데 입력 파일과 입력 버퍼를 모두 등록하려는 경우입니다. | 엔진 오류. |
| -5 | gw2ret_incorrectPolicySetup | policy 파일을 로드할 수 없거나 콘텐츠 오류가 있습니다. | 엔진 오류. |
| -6 | gw2ret_unableToLoadInput | 입력 파일을 로드하거나 해당 파일이 포함된 버퍼에 액세스할 수 없습니다. | 엔진 오류. |
| -7 | gw2ret_fileTypeUnknown | 파일 형식을 확인할 수 없습니다 | 인식할 수 없는 파일입니다. |
| -8 | gw2ret_unknownSessionID | API 호출에 사용된 Session ID가 활성 Session 목록에 없습니다. Session이 생성되지 않았거나 이미 삭제되었습니다. | 엔진 오류. |
| -9 | gw2ret_argumentError | API 호출의 인수 중 하나가 올바르지 않습니다. | 엔진 오류. |
| -10 | gw2ret_unableToLoadImport | 가져오기 데이터 파일을 로드하거나 해당 파일이 포함된 버퍼에 액세스할 수 없습니다. | 엔진 오류. |
| -11 | gw2ret_cameraDidNotInitialise | 카메라 plugin을 초기화하지 못했습니다. | 엔진 오류. |
| -12 | gw2ret_noCamerasConnected | 로드된 카메라 plugin이 없습니다. | 엔진 오류. |
| -13 | gw2ret_engineeringOnlyGoesToFile | 사용되지 않음. 향후 사용을 위해 예약됨. | 엔진 오류. |
| -14 | gw2ret_unableToWriteOutput | 출력 파일 또는 이를 기대하는 버퍼에 쓸 수 없습니다. | 엔진 오류. |
| -15 | gw2ret_unableToWriteExport | 내보내기 데이터 파일 또는 이를 기대하는 버퍼에 쓸 수 없습니다. | 엔진 오류. |
| -16 | gw2ret_fileRejected | 파일은 성공적으로 Processed되었지만 policy 설정에 의해 허용되지 않았습니다. analysis 또는 GW2FileErrorMsg API 호출을 참조하십시오. | 파일이 처리되었지만 폐기되었습니다. |
| -17 | gw2ret_unableToWriteExportTextDump | 텍스트 내보내기 출력 파일에 쓸 수 없습니다. | 엔진 오류. |
| -18 | gw2ret_unableToWriteAnalysisReport | analysis 보고서 출력 파일에 쓸 수 없습니다. | 엔진 오류. |
| -19 | gw2ret_inputTooLarge | 입력 파일 크기가 2GiB 제한을 초과합니다. | 유효하지 않은 파일입니다. |
| -20 | gw2ret_inputZeroBytes | 입력 파일 크기가 0바이트입니다. | 유효하지 않은 파일입니다. |
정상으로 인식됨
| 값 | 시스템 이름 |
|---|---|
| 1 | gw2ret_ok_withcleaning |
| 0 | gw2ret_ok |
손상된 것으로 인식됨
| 값 | 시스템 이름 |
|---|---|
| -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에 설명된 각 함수는, 자세한 설명에서 달리 명시되지 않는 한 이러한 값 중 하나가 반환된다고 가정합니다.