hi_return_codes.h File Reference

This file defines the return codes for the HttpInspect functions. More...

#include "hi_include.h"

Go to the source code of this file.

Defines
#define	HI_BOOL_FALSE   0
#define	HI_SUCCESS   0
#define	HI_BOOL_TRUE   1
#define	HI_NONFATAL_ERR   1
#define	HI_OUT_OF_BOUNDS   2
#define	HI_FATAL_ERR   -1
#define	HI_INVALID_ARG   -2
#define	HI_MEM_ALLOC_FAIL   -3
#define	HI_NOT_FOUND   -4
#define	HI_INVALID_FILE   -5

---

Detailed Description

This file defines the return codes for the HttpInspect functions.

Author:

Daniel Roelker <droelker@sourcefire.com>

Common return codes are defined here for all functions and libraries to use. This should make function error checking easier.

NOTES:

• 2.14.03: Initial Development. DJR

Definition in file hi_return_codes.h.

---

Define Documentation

#define HI_BOOL_FALSE   0

Definition at line 22 of file hi_return_codes.h. Referenced by hi_eo_generate_event().

#define HI_BOOL_TRUE   1

Definition at line 28 of file hi_return_codes.h. Referenced by hi_eo_generate_event().

#define HI_FATAL_ERR   -1

Definition at line 35 of file hi_return_codes.h. Referenced by FindCodePage(), MapCodePoints(), and ProcessIISUnicodeMap().

#define HI_INVALID_ARG   -2

Definition at line 36 of file hi_return_codes.h. Referenced by CheckChunkEncoding(), hi_client_inspection(), hi_client_norm(), hi_eo_anom_server_event_log(), hi_eo_client_event_log(), hi_mi_mode_inspection(), hi_normalization(), hi_server_anomaly_detection(), hi_server_inspection(), hi_ui_config_default(), hi_ui_config_set_profile_all(), hi_ui_config_set_profile_iis(), hi_ui_parse_iis_unicode_map(), hi_ui_server_lookup_add(), hi_ui_server_lookup_find(), hi_ui_server_lookup_first(), hi_ui_server_lookup_next(), IsHttpServerData(), PrintConfOpt(), PrintServerConf(), and StatelessInspection().

#define HI_INVALID_FILE   -5

Definition at line 39 of file hi_return_codes.h. Referenced by hi_ui_parse_iis_unicode_map(), and ProcessIISUnicodeMap().

#define HI_MEM_ALLOC_FAIL   -3

Definition at line 37 of file hi_return_codes.h. Referenced by hi_ui_parse_iis_unicode_map(), hi_ui_server_lookup_add(), hi_ui_server_lookup_init(), and ProcessProfile().

#define HI_NONFATAL_ERR   1

Definition at line 29 of file hi_return_codes.h. Referenced by hi_client_inspection(), hi_mi_mode_inspection(), hi_norm_uri(), hi_ui_server_lookup_add(), InspectUriChar(), ProcessUniqueServerConf(), SetClientVars(), StatefulSessionInspection(), and StatelessInspection().

#define HI_NOT_FOUND   -4

Definition at line 38 of file hi_return_codes.h. Referenced by hi_ui_server_lookup_find(), hi_ui_server_lookup_first(), and hi_ui_server_lookup_next().

#define HI_OUT_OF_BOUNDS   2

Definition at line 30 of file hi_return_codes.h. Referenced by find_rfc_delimiter(), NextNonWhiteSpace(), SetSlashNorm(), and StatelessInspection().

#define HI_SUCCESS   0

Definition at line 23 of file hi_return_codes.h. Referenced by CheckChunkEncoding(), CheckLongDir(), DirSet(), DirTrav(), FindCodePage(), hi_client_init(), hi_client_inspection(), hi_client_norm(), hi_eo_anom_server_event_log(), hi_eo_client_event_log(), hi_mi_mode_inspection(), hi_norm_init(), hi_norm_uri(), hi_normalization(), hi_server_anomaly_detection(), hi_server_inspection(), hi_si_session_inspection(), hi_ui_config_add_server(), hi_ui_config_default(), hi_ui_config_init_global_conf(), hi_ui_config_reset_global(), hi_ui_config_reset_server(), hi_ui_config_set_profile_all(), hi_ui_config_set_profile_apache(), hi_ui_config_set_profile_iis(), hi_ui_parse_iis_unicode_map(), hi_ui_server_lookup_add(), hi_ui_server_lookup_find(), hi_ui_server_lookup_first(), hi_ui_server_lookup_init(), hi_ui_server_lookup_next(), InitServerConf(), InspectUriChar(), IsHttpServerData(), MapCodePoints(), NextNonWhiteSpace(), ResetSession(), ServerInspection(), SetBackSlashNorm(), SetBinaryNorm(), SetClientVars(), SetParamField(), SetPercentNorm(), SetProxy(), SetSiInput(), SetSlashNorm(), StatelessInspection(), StatelessSessionInspection(), and UriNorm().

---