# tensorflow::Status

`#include <status.h>`

Denotes success or failure of a call in Tensorflow.

## Summary

| ### Constructors and Destructors ||
|---|---|
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a71ab5e0bcbba7dce4f36a9655244ba28()` Create a success status. ||
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1ae5db42baf704c6cfd9b2218258e2ecb0(tensorflow::error::Code code, tensorflow::StringPiece msg)` Create a status with the specified error code and msg as a human-readable string containing more detailed information. ||
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a1601d7da5d517e2292c4550c4dabd4f6(const https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status & s)` Copy the specified status. ||

| ### Public functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1ab716b30a0414df51c44293d437bcb6d1() const ` | `void` |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1ae9ec82110337db2d5f7fccbf074c576f() const ` | `string` Return a string representation of this status suitable for printing. |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a167c59a5e6ec8bb8b5fa480a225d0fa1(const https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status & new_status)` | `void` If `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a6c078283eadeeb5ed337f36582138c00`, stores `new_status` into `*this`. |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1ae7e45879c3f69b952877461a02950ce9() const ` | `tensorflow::error::Code` |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1ab354605de9047f27583cc93d9b256aca() const ` | `const string &` |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a6c078283eadeeb5ed337f36582138c00() const ` | `bool` Returns true iff the status indicates success. |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a60ddc141060b51174bdd78c65c933a43(const https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status & x) const ` | `bool` |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a0dda7e9456d71fb05365b62136526a94(const https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status & s)` | `void` |
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1aea3db351a06f796f13ab9ca483d53f73(const https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status & x) const ` | `bool` |

| ### Public static functions ||
|---|---|
| `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a2c9dab72c1556a7a88706947dff45944()` | `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status` |

## Public functions

### IgnoreError

```
void IgnoreError() const 
```

### Status

```
 Status()
```
Create a success status.

### Status

```
 Status(
  tensorflow::error::Code code,
  tensorflow::StringPiece msg
)
```
Create a status with the specified error code and msg as a human-readable string containing more detailed information.

### Status

```
 Status(
  const Status & s
)
```
Copy the specified status.

### ToString

```
string ToString() const 
```
Return a string representation of this status suitable for printing.

Returns the string `"OK"` for success.

### Update

```
void Update(
  const Status & new_status
)
```
If `https://www.tensorflow.org/versions/r2.1/api_docs/cc/class/tensorflow/status#classtensorflow_1_1_status_1a6c078283eadeeb5ed337f36582138c00`, stores `new_status` into `*this`.

If `!ok()`, preserves the current status, but may augment with additional information about `new_status`.

Convenient way of keeping track of the first error encountered. Instead of: `if (overall_status.ok()) overall_status = new_status` Use: `overall_status.Update(new_status);`

### code

```
tensorflow::error::Code code() const 
```

### error_message

```
const string & error_message() const 
```

### ok

```
bool ok() const 
```
Returns true iff the status indicates success.

### operator!=

```
bool operator!=(
  const Status & x
) const 
```

### operator=

```
void operator=(
  const Status & s
)
```

### operator==

```
bool operator==(
  const Status & x
) const 
```

## Public static functions

### OK

```
Status OK()
```