> For the complete documentation index, see [llms.txt](https://docs.medcrypt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.medcrypt.com/guardian/api-overview/api-reference/namespaces/namespacemedcrypt-guardian-guardianstatusenum.md).

# medcrypt::guardian::GuardianStatusEnum

## Types

|      | Name                                                                                                                                                                                                                                                                                                                                                   |
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| enum | [**Type**](#enum-type) { OK = 0x00, FAIL = 0x01, BADPARAM = 0x02, MISCONFIGURED = 0x03, INCOMPLETE = 0x04, DENIED = 0x05, BADINIT = 0x06, PROTOCOL = 0x07, OUTOFMEMORY = 0x08, VERIFYFAIL = 0x09, FILENOTFOUND = 0x0A, ZEROSIZEFILE = 0x0B, NOWRITE = 0x0C, SHUTDOWN = 0x0D, AGAIN = 0x0E, HANDSHAKEREQUIRED = 0x0F, TIMEOUT = 0x10, BINDFAIL = 0x11 } |

## Functions

|                    | Name                                                                |
| ------------------ | ------------------------------------------------------------------- |
| std::string        | [**NameOf**](#function-nameof)(const [Type](#enum-type) & in\_enum) |
| [Type](#enum-type) | [**Enum**](#function-enum)(const std::string & in\_string)          |
| bool               | [**IsValid**](#function-isvalid)(const int & in\_value)             |

## Types Documentation

### enum Type

| Enumerator        | Value | Description                            |
| ----------------- | ----- | -------------------------------------- |
| OK                | 0x00  | call completed successfully            |
| FAIL              | 0x01  | call completed unsuccessfully          |
| BADPARAM          | 0x02  | issue with provided parameter          |
| MISCONFIGURED     | 0x03  | a configuration blocked the call       |
| INCOMPLETE        | 0x04  | the process started but did not finish |
| DENIED            | 0x05  | operation not allowed                  |
| BADINIT           | 0x06  | call on non-initialized object         |
| PROTOCOL          | 0x07  | guardian protocol error                |
| OUTOFMEMORY       | 0x08  | not enough memory                      |
| VERIFYFAIL        | 0x09  | signature verification failed          |
| FILENOTFOUND      | 0x0A  | could not read all necessary files     |
| ZEROSIZEFILE      | 0x0B  | provided file is zero length           |
| NOWRITE           | 0x0C  | could not write file                   |
| SHUTDOWN          | 0x0D  | the object is shutdown                 |
| AGAIN             | 0x0E  | non-blocking call, try again           |
| HANDSHAKEREQUIRED | 0x0F  | complete handshake before retry        |
| TIMEOUT           | 0x10  | the process timed out                  |
| BINDFAIL          | 0x11  | could not bind to socket or handle     |

## Functions Documentation

### function NameOf

```cpp
std::string NameOf(
    const Type & in_enum
)
```

### function Enum

```cpp
Type Enum(
    const std::string & in_string
)
```

### function IsValid

```cpp
bool IsValid(
    const int & in_value
)
```